Released in microprofile-openapi-api 4.0.2.
A set of Java interfaces, annotations, and programming models which allow Java developers to natively produce OpenAPI documents from Jakarta RESTful Web Services applications.
| Modifier and Type | Package and Description |
|---|---|
| exported package | org.
A set of Java interfaces, annotations and programming models which allow Java developers to natively produce OpenAPI v3.1 documents from their Jakarta REST applications. |
| exported package | org.
A set of annotations, many derived from Swagger Core library. |
| exported package | org.
A set of annotations to represent callback URL or an array of relevant callback URLs that can be invoked for a particular HTTP operation as well as the HTTP operation that will be invoked with the callback. |
| exported package | org.
A set of parameters used by other annotations to represent their enumerable properties. |
| exported package | org.
Annotations to represent additional data to extend existing OpenAPI specifications. |
| exported package | org.
An annotation to describe a single header object. |
| exported package | org.
A set of annotations to represent metadata about the API, including license information and contact information of the exposed API. |
| exported package | org.
Annotations to represent a design-time link for a response and the corresponding parameter to be passed to the linked operation. |
| exported package | org.
A set of annotations to represent input and output data type, media type and relevant examples. |
| exported package | org.
A set of annotations to describe and encapsulate operation parameters and operation's request body. |
| exported package | org.
Contains annotation to describe a single response from an API operation, and an annotation to encapsulate multiple responses from an API operation. |
| exported package | org.
A set of annotations to represent various security components of an OpenAPI app. |
| exported package | org.
Annotations to represent servers used for a single API operation or for all operations in an OpenAPI document, as well as a way to represent variables for server URL template substitution. |
| exported package | org.
A set of annotations to represent a tag for an API endpoint and a container that encapsulates multiple such tags. |
| exported package | org.
A set of interfaces for programmable models and their helper classes, many derived from Swagger Core library. |
| exported package | org.
An interface to represent callback URL. |
| exported package | org.
An interface to represent a programmable model of an example of a data type or a media type. |
| exported package | org.
An interface of a programmable model to represent a single header object. |
| exported package | org.
A set of interfaces of programmable models to represent metadata about the API, including license information and contact information of the exposed API. |
| exported package | org.
An interface of a model to represent a design-time link for a response. |
| exported package | org.
A set of interfaces for programmable models to represent input and output data types and media types. |
| exported package | org.
A set of model interfaces to describe operation parameters and operation's request body. |
| exported package | org.
Model interfaces to describe a single response from an API operation, and an annotation to encapsulate multiple responses from an API operation. |
| exported package | org.
A set of model interfaces to represent various security components of an OpenAPI app. |
| exported package | org.
Model interfaces to represent servers used for a single API operation or for all operations in an OpenAPI document, as well as a way to represent variables for server URL template substitution. |
| exported package | org.
Model interface to represent a tag of an API endpoint. |
| exported package | org.
Service provider interface which allows vendors to set their implementations of OASFactoryResolver. |