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

@Version("1.0") @ProviderType package org.eclipse.microprofile.openapi.annotations.info

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")))
 

Related Packages

Package	Description
org.eclipse.microprofile.openapi.annotations	A set of annotations, many derived from Swagger Core library.

Annotation Interfaces

Class	Description
Contact	Contact information for the exposed API.
Info	This annotation provides metadata about the API, and maps to the Info object in OpenAPI Specification 3.
License	License information for the exposed API.