Uses of Class
org.apache.juneau.bean.openapi3.OpenApi

Packages that use OpenApi

Package	Description
org.apache.juneau.bean.openapi3	Swagger Data Transfer Objects
org.apache.juneau.bean.openapi3.ui	OpenAPI UI Generator
org.apache.juneau.rest.server	REST Server API
org.apache.juneau.rest.server.docs	API-docs mixin pack — composable @Rest(mixins=...) resources that publish Swagger v2 and OpenAPI 3.1 spec endpoints with Swagger-UI and Redoc HTML mounts.
org.apache.juneau.rest.server.openapi	Server-side OpenAPI 3.1 emission — the OpenApiProvider SPI and the BasicOpenApiProvider default implementation that walks an RestContext and produces an OpenApi document.

Uses of OpenApi in org.apache.juneau.bean.openapi3

Fields in org.apache.juneau.bean.openapi3 declared as OpenApi

Modifier and Type	Field	Description
static final OpenApi	OpenApi.NULL	Represents a null OpenAPI document

Methods in org.apache.juneau.bean.openapi3 that return OpenApi

Modifier and Type	Method	Description
OpenApi	OpenApi.addPath(String path, PathItem pathItem)	Adds a path to this OpenAPI document.
OpenApi	OpenApi.addSecurity(Collection<SecurityRequirement> values)	Bean property fluent setter: security.
OpenApi	OpenApi.addSecurity(SecurityRequirement... values)	Bean property fluent setter: security.
OpenApi	OpenApi.addServers(Collection<Server> values)	Bean property fluent setter: servers.
OpenApi	OpenApi.addServers(Server... values)	Bean property fluent setter: servers.
OpenApi	OpenApi.addTags(Collection<Tag> values)	Bean property appender: tags.
OpenApi	OpenApi.addTags(Tag... values)	Bean property appender: tags.
OpenApi	OpenApi.copy()	Make a deep copy of this object.
static final OpenApi	OpenApiBuilder.openApi()	Creates an empty OpenApi element.
static final OpenApi	OpenApiBuilder.openApi(Info info)	Creates an OpenApi element with the specified info attribute.
OpenApi	OpenApi.set(String property, Object value)
OpenApi	OpenApi.setComponents(Components value)	Sets the components object.
OpenApi	OpenApi.setExternalDocs(ExternalDocumentation value)	Sets the external documentation.
OpenApi	OpenApi.setInfo(Info value)	Sets the info object.
OpenApi	OpenApi.setOpenapi(String value)	Sets the OpenAPI version.
OpenApi	OpenApi.setPaths(Map<String,PathItem> value)	Sets the paths map.
OpenApi	OpenApi.setSecurity(List<SecurityRequirement> value)	Sets the security requirements list.
OpenApi	OpenApi.setSecurity(SecurityRequirement... value)	Sets the security requirements list.
OpenApi	OpenApi.setServers(List<Server> value)	Sets the servers list.
OpenApi	OpenApi.setServers(Server... value)	Sets the servers list.
OpenApi	OpenApi.setTags(List<Tag> value)	Sets the tags list.
OpenApi	OpenApi.setTags(Tag... value)	Bean property setter: tags.
OpenApi	OpenApi.strict()
OpenApi	OpenApi.strict(Object value)

Methods in org.apache.juneau.bean.openapi3 with parameters of type OpenApi

Modifier and Type	Method	Description
HeaderInfo	HeaderInfo.resolveRefs(OpenApi openApi, Deque<String> refStack, int maxDepth)	Resolves any "$ref" attributes in this element.
Items	Items.resolveRefs(OpenApi openApi, Deque<String> refStack, int maxDepth)	Resolves any "$ref" attributes in this element.
SchemaInfo	SchemaInfo.resolveRefs(OpenApi openApi, Deque<String> refStack, int maxDepth)	Resolves any "$ref" attributes in this element.

Constructors in org.apache.juneau.bean.openapi3 with parameters of type OpenApi

Modifier	Constructor	Description
	OpenApi(OpenApi copyFrom)	Copy constructor.

Uses of OpenApi in org.apache.juneau.bean.openapi3.ui

Methods in org.apache.juneau.bean.openapi3.ui with parameters of type OpenApi

Modifier and Type	Method	Description
Div	OpenApiUI.swap(MarshallingSession marshallingSession, OpenApi openApi)
Div	RedocUI.swap(MarshallingSession session, OpenApi openApi)

Uses of OpenApi in org.apache.juneau.rest.server

Fields in org.apache.juneau.rest.server with type parameters of type OpenApi

Modifier and Type	Field	Description
protected final ConcurrentHashMap<Locale,OpenApi>	RestContext.openApiCache

Methods in org.apache.juneau.rest.server that return types with arguments of type OpenApi

Modifier and Type	Method	Description
Optional<OpenApi>	RestContext.getOpenApi(Locale locale)	Returns the OpenAPI 3.1 document for the REST resource.
Optional<OpenApi>	RestRequest.getOpenApi()	Returns the localized OpenAPI 3.1 document associated with the resource.

Uses of OpenApi in org.apache.juneau.rest.server.docs

Methods in org.apache.juneau.rest.server.docs that return OpenApi

Modifier and Type	Method	Description
OpenApi	OpenApiMixin.getOpenApi(RestRequest req)	[GET /openapi] — emit the OpenAPI 3.1 document for this resource.
OpenApi	RedocMixin.getRedoc(RestRequest req)	[GET /redoc] — render the Redoc HTML view (or the spec, depending on Accept).

Uses of OpenApi in org.apache.juneau.rest.server.openapi

Methods in org.apache.juneau.rest.server.openapi that return OpenApi

Modifier and Type	Method	Description
OpenApi	BasicOpenApiProvider.getOpenApi(RestContext context, Locale locale)	Returns the OpenAPI 3.1 document associated with the specified context of a Rest-annotated class.
OpenApi	BasicOpenApiProviderSession.getOpenApi()	Generates the OpenAPI 3.1 document.
OpenApi	OpenApiProvider.getOpenApi(RestContext context, Locale locale)	Returns the OpenAPI 3.1 document associated with the specified Rest-annotated class.