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.
|
Modifier and Type | Method and Description |
---|---|
OpenAPI |
OASModelReader.buildModel()
This method is called by the vendor's OpenAPI processing framework.
|
static OpenAPI |
OASFactory.createOpenAPI()
This method creates a new
OpenAPI instance. |
Modifier and Type | Method and Description |
---|---|
default void |
OASFilter.filterOpenAPI(OpenAPI openAPI)
Allows filtering of the singleton OpenAPI element.
|
Modifier and Type | Method and Description |
---|---|
OpenAPI |
OpenAPI.addSecurityRequirement(SecurityRequirement securityRequirement)
Adds the given security requirement to this OpenAPI instance's list of security requirements.
|
OpenAPI |
OpenAPI.addServer(Server server)
Adds the given server to this OpenAPI instance's list of servers.
|
OpenAPI |
OpenAPI.addTag(Tag tag)
Adds the given tag to this OpenAPI instance's list of tags.
|
default OpenAPI |
OpenAPI.components(Components components)
Sets this OpenAPI instance's components property to the given components.
|
default OpenAPI |
OpenAPI.externalDocs(ExternalDocumentation externalDocs)
Sets this OpenAPI instance's externalDocs property to the given object.
|
default OpenAPI |
OpenAPI.info(Info info)
Sets this OpenAPI instance's info property to the given object.
|
default OpenAPI |
OpenAPI.openapi(String openapi)
Sets this OpenAPI instance's openapi property to the given string.
|
default OpenAPI |
OpenAPI.paths(Paths paths)
Sets this OpenAPI instance's paths property to the given paths.
|
default OpenAPI |
OpenAPI.security(List<SecurityRequirement> security)
Sets this OpenAPI instance's security property to the given list.
|
default OpenAPI |
OpenAPI.servers(List<Server> servers)
Sets this OpenAPI instance's servers property to the given servers.
|
default OpenAPI |
OpenAPI.tags(List<Tag> tags)
Sets this OpenAPI instance's tags property to the given tags.
|
Copyright © 2017 – 2022 Eclipse Foundation. All rights reserved.
Use is subject to license terms.