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.
|
Class and Description |
---|
Components
Components
|
Constructible
Marker interface for OpenAPI model objects that can be constructed by the OASFactory.
|
ExternalDocumentation
ExternalDocumentation
|
OpenAPI
OpenAPI
|
Operation
Operation
|
PathItem
PathItem
|
Paths
Paths
|
Class and Description |
---|
Components
Components
|
Constructible
Marker interface for OpenAPI model objects that can be constructed by the OASFactory.
|
Extensible
The base interface for OpenAPI model objects that can contain extensions.
|
ExternalDocumentation
ExternalDocumentation
|
OpenAPI
OpenAPI
|
Operation
Operation
|
PathItem
PathItem
|
PathItem.HttpMethod
All of the possible types of HTTP operations for this path
|
Paths
Paths
|
Reference
Base interface for OpenAPI model objects that can make reference to other objects.
|
Class and Description |
---|
Constructible
Marker interface for OpenAPI model objects that can be constructed by the OASFactory.
|
Extensible
The base interface for OpenAPI model objects that can contain extensions.
|
PathItem
PathItem
|
Reference
Base interface for OpenAPI model objects that can make reference to other objects.
|
Class and Description |
---|
Constructible
Marker interface for OpenAPI model objects that can be constructed by the OASFactory.
|
Extensible
The base interface for OpenAPI model objects that can contain extensions.
|
Reference
Base interface for OpenAPI model objects that can make reference to other objects.
|
Class and Description |
---|
Constructible
Marker interface for OpenAPI model objects that can be constructed by the OASFactory.
|
Extensible
The base interface for OpenAPI model objects that can contain extensions.
|
Reference
Base interface for OpenAPI model objects that can make reference to other objects.
|
Class and Description |
---|
Constructible
Marker interface for OpenAPI model objects that can be constructed by the OASFactory.
|
Extensible
The base interface for OpenAPI model objects that can contain extensions.
|
Class and Description |
---|
Constructible
Marker interface for OpenAPI model objects that can be constructed by the OASFactory.
|
Extensible
The base interface for OpenAPI model objects that can contain extensions.
|
Reference
Base interface for OpenAPI model objects that can make reference to other objects.
|
Class and Description |
---|
Constructible
Marker interface for OpenAPI model objects that can be constructed by the OASFactory.
|
Extensible
The base interface for OpenAPI model objects that can contain extensions.
|
ExternalDocumentation
ExternalDocumentation
|
Reference
Base interface for OpenAPI model objects that can make reference to other objects.
|
Class and Description |
---|
Constructible
Marker interface for OpenAPI model objects that can be constructed by the OASFactory.
|
Extensible
The base interface for OpenAPI model objects that can contain extensions.
|
Reference
Base interface for OpenAPI model objects that can make reference to other objects.
|
Class and Description |
---|
Constructible
Marker interface for OpenAPI model objects that can be constructed by the OASFactory.
|
Extensible
The base interface for OpenAPI model objects that can contain extensions.
|
Reference
Base interface for OpenAPI model objects that can make reference to other objects.
|
Class and Description |
---|
Constructible
Marker interface for OpenAPI model objects that can be constructed by the OASFactory.
|
Extensible
The base interface for OpenAPI model objects that can contain extensions.
|
Reference
Base interface for OpenAPI model objects that can make reference to other objects.
|
Class and Description |
---|
Constructible
Marker interface for OpenAPI model objects that can be constructed by the OASFactory.
|
Extensible
The base interface for OpenAPI model objects that can contain extensions.
|
Class and Description |
---|
Constructible
Marker interface for OpenAPI model objects that can be constructed by the OASFactory.
|
Extensible
The base interface for OpenAPI model objects that can contain extensions.
|
ExternalDocumentation
ExternalDocumentation
|
Class and Description |
---|
Constructible
Marker interface for OpenAPI model objects that can be constructed by the OASFactory.
|
Copyright © 2017 – 2020 Eclipse Foundation. All rights reserved.
Use is subject to license terms.