Top Description Annotations
module org.eclipse.microprofile.openapi

Package org.eclipse.microprofile.openapi.annotations.info

Annotations
@Version:1.2
@ProviderType
A set of annotations to represent metadata about the API, including license information and contact information of the exposed API.

Example usage: 

@ApplicationPath("/")
  @OpenAPIDefinition(
   info = @Info(
       title="AirlinesRatingApp API",
       version = "1.0",
       termsOfService = "http://airlinesratingapp.com/terms",
       contact = @Contact(
           name = "AirlinesRatingApp API Support",
           url = "http://exampleurl.com/contact",
           email = "[email protected]"),
       license = @License(
           name = "Apache 2.0",
           url = "http://www.apache.org/licenses/LICENSE-2.0.html")))

Annotation Summary

Modifier and TypeAnnotation and Description
public @interface
Contact

Contact information for the exposed API.

public @interface
Info

This annotation provides metadata about the API, and maps to the Info object in OpenAPI Specification 3.

public @interface
License

License information for the exposed API.