Top Description Interfaces
module org.eclipse.microprofile.openapi

Package org.eclipse.microprofile.openapi.models.info

Annotations
@Version:1.1
@ProviderType

A set of interfaces of programmable models to represent metadata about the API, including license information and contact information of the exposed API.

The behaviour of methods inherited from java.lang.Object are undefined by the MicroProfile OpenAPI specification.

Example:

public class MyOASModelReaderImpl implements OASModelReader {

 @Override
 public OpenAPI buildModel() {
     return OASFactory.createObject(OpenAPI.class)
             .info(OASFactory.createObject(Info.class)
                 .title("AirlinesRatingApp API")
                 .version("1.0")
                 .termsOfService("http://airlinesratingapp.com/terms")
                 .contact(OASFactory.createObject(Contact.class)
                     .name("AirlinesRatingApp API Support")
                     .url("http://exampleurl.com/contact")
                     .email("techsupport@airlinesratingapp.com"))
                 .license(OASFactory.createObject(License.class)
                     .name("Apache 2.0")
                     .url("http://www.apache.org/licenses/LICENSE-2.0.html")))
 }

Interface Summary

Modifier and TypeInterface and Description
public interface
Contact

This interface represents the Contact information for the exposed API.

public interface
Info

This interface represents all the metadata about the API.

public interface
License

This interface represents the License information for the exposed API.