Package | Description |
---|---|
org.eclipse.microprofile.openapi |
A set of Java interfaces, annotations and programming models which allow Java developers to natively produce OpenAPI
v3 documents from their JAX-RS applications.
|
org.eclipse.microprofile.openapi.models |
A set of interfaces for programmable models and their helper classes, many derived from Swagger Core library.
|
org.eclipse.microprofile.openapi.models.callbacks |
An interface to represent callback URL.
|
org.eclipse.microprofile.openapi.models.examples |
An interface to represent a programmable model of an example of a data type or a media type.
|
org.eclipse.microprofile.openapi.models.headers |
An interface of a programmable model to represent a single header object.
|
org.eclipse.microprofile.openapi.models.info |
A set of interfaces of programmable models to represent metadata about the API, including license information and
contact information of the exposed API.
|
org.eclipse.microprofile.openapi.models.links |
An interface of a model to represent a design-time link for a response.
|
org.eclipse.microprofile.openapi.models.media |
A set of interfaces for programmable models to represent input and output data types and media types.
|
org.eclipse.microprofile.openapi.models.parameters |
A set of model interfaces to describe operation parameters and operation's request body.
|
org.eclipse.microprofile.openapi.models.responses |
Model interfaces to describe a single response from an API operation, and an annotation to encapsulate multiple
responses from an API operation.
|
org.eclipse.microprofile.openapi.models.security |
A set of model interfaces to represent various security components of an OpenAPI app.
|
org.eclipse.microprofile.openapi.models.servers |
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.
|
org.eclipse.microprofile.openapi.models.tags |
Model interface to represent a tag of an API endpoint.
|
org.eclipse.microprofile.openapi.spi |
Service provider interface which allows vendors to set their implementations of OASFactoryResolver.
|
Modifier and Type | Method and Description |
---|---|
static <T extends Constructible> |
OASFactory.createObject(Class<T> clazz)
This method creates a new instance of a constructible element from the OpenAPI model tree.
|
Modifier and Type | Interface and Description |
---|---|
interface |
Components
Components
|
interface |
ExternalDocumentation
ExternalDocumentation
|
interface |
OpenAPI
OpenAPI
|
interface |
Operation
Operation
|
interface |
PathItem
PathItem
|
interface |
Paths
Paths
|
Modifier and Type | Interface and Description |
---|---|
interface |
Callback
Callback
|
Modifier and Type | Interface and Description |
---|---|
interface |
Example
Example
|
Modifier and Type | Interface and Description |
---|---|
interface |
Header
Header
|
Modifier and Type | Interface and Description |
---|---|
interface |
Contact
This interface represents the Contact information for the exposed API.
|
interface |
Info
This interface represents all the metadata about the API.
|
interface |
License
This interface represents the License information for the exposed API.
|
Modifier and Type | Interface and Description |
---|---|
interface |
Link
Link
|
Modifier and Type | Interface and Description |
---|---|
interface |
Content
Content
|
interface |
Discriminator
Discriminator
|
interface |
Encoding
Encoding
|
interface |
MediaType
MediaType
|
interface |
Schema
The Schema Object allows the definition of input and output data types.
|
interface |
XML
A metadata object that allows for more fine-tuned XML model definitions.
|
Modifier and Type | Interface and Description |
---|---|
interface |
Parameter
Parameter
|
interface |
RequestBody
This interface represents the request body of an operation in which body parameters can be specified.
|
Modifier and Type | Interface and Description |
---|---|
interface |
APIResponse
This interface represents a single response from an API Operation, including design-time, static links to operations
based on the response.
|
interface |
APIResponses
This interface represents the container for the expected responses of an operation.
|
Modifier and Type | Interface and Description |
---|---|
interface |
OAuthFlow
Configuration details for a supportde OAuthFlow
|
interface |
OAuthFlows
Configuration of the supported OAuthFlows
|
interface |
SecurityRequirement
SecurityRequirement
|
interface |
SecurityScheme
SecurityScheme
|
Modifier and Type | Interface and Description |
---|---|
interface |
Server
An object representing a server.
|
interface |
ServerVariable
An object representing a Server Variable for server URL template substitution.
|
Modifier and Type | Interface and Description |
---|---|
interface |
Tag
Tag
|
Modifier and Type | Method and Description |
---|---|
abstract <T extends Constructible> |
OASFactoryResolver.createObject(Class<T> clazz)
Create a new instance of a constructible element from the OpenAPI model tree.
|
Copyright © 2017 – 2022 Eclipse Foundation. All rights reserved.
Use is subject to license terms.