Package org.apache.juneau.rest.server.openapi

Interface OpenApiProvider

All Known Implementing Classes:

BasicOpenApiProvider, OpenApiProvider.Void

public interface OpenApiProvider

Interface for retrieving an OpenApi 3.1 document from a REST resource.

Sibling of SwaggerProvider for OpenAPI 3.1 emission. Both providers coexist; the @Rest(openApiProvider=...) attribute selects the implementation.

See Also:

• API-Docs Mixin Pack

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	OpenApiProvider.Builder	Builder class for OpenApiProvider instances.
static class	OpenApiProvider.Void	Represents no OpenApiProvider.

Method Summary

Modifier and Type	Method	Description
static OpenApiProvider.Builder	create(BeanStore beanStore)	Static creator.
OpenApi	getOpenApi(RestContext context, Locale locale)	Returns the OpenAPI 3.1 document associated with the specified Rest-annotated class.

Method Details

create

static OpenApiProvider.Builder create(BeanStore beanStore)

Static creator.

Parameters:

beanStore - The bean store to use for creating beans.

Returns:

A new builder for this object.

getOpenApi

OpenApi getOpenApi(RestContext context,
 Locale locale)
            throws Exception

Returns the OpenAPI 3.1 document associated with the specified Rest-annotated class.

Parameters:

context - The context of the Rest-annotated class.

locale - The request locale.

Returns:

A new OpenApi DTO object.

Throws:

Exception - If an error occurred producing the document.