MicroProfile OpenAPI API
Packages
Package
Description
A set of Java interfaces, annotations and programming models which allow Java developers to natively produce OpenAPI
v3 documents from their JAX-RS applications.
A set of annotations, many derived from Swagger Core library.
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.
A set of parameters used by other annotations to represent their enumerable properties.
Annotations to represent additional data to extend existing OpenAPI specifications.
An annotation to describe a single header object.
A set of annotations to represent metadata about the API, including license information and contact information of
the exposed API.
Annotations to represent a design-time link for a response and the corresponding parameter to be passed to the linked
operation.
A set of annotations to represent input and output data type, media type and relevant examples.
A set of annotations to describe and encapsulate operation parameters and operation's request body.
Contains annotation to describe a single response from an API operation, and an annotation to encapsulate multiple
responses from an API operation.
A set of annotations to represent various security components of an OpenAPI app.
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.
A set of annotations to represent a tag for an API endpoint and a container that encapsulates multiple such tags.
A set of interfaces for programmable models and their helper classes, many derived from Swagger Core library.
An interface to represent callback URL.
An interface to represent a programmable model of an example of a data type or a media type.
An interface of a programmable model to represent a single header object.
A set of interfaces of programmable models to represent metadata about the API, including license information and
contact information of the exposed API.
An interface of a model to represent a design-time link for a response.
A set of interfaces for programmable models to represent input and output data types and media types.
A set of model interfaces to describe operation parameters and operation's request body.
Model interfaces to describe a single response from an API operation, and an annotation to encapsulate multiple
responses from an API operation.
A set of model interfaces to represent various security components of an OpenAPI app.
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.
Model interface to represent a tag of an API endpoint.
Service provider interface which allows vendors to set their implementations of OASFactoryResolver.