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

Class BasicOpenApiProviderSession

java.lang.Object

org.apache.juneau.rest.server.openapi.BasicOpenApiProviderSession

public class BasicOpenApiProviderSession
extends Object

A single session of generating an OpenAPI 3.1 document.

Reuses the BasicSwaggerProviderSession machinery to produce a Swagger 2.0 document, then applies the well-known Swagger 2.0 → OpenAPI 3.1 transformation (servers from host/basePath/schemes, requestBody from in:body and in:formData parameters, content negotiation moved to per-response blocks, definitions lifted to components.schemas, $ref rewritten under "#/components/schemas/", etc) and parses the resulting JSON into an OpenApi bean.

The transformation runs at the JSON level on the Json5 representation of the Swagger document, which keeps the conversion rules co-located and makes them straightforward to extend without touching the underlying annotation-walker.

See Also:

• API-Docs Mixin Pack

Constructor Summary

Constructors

Constructor	Description
BasicOpenApiProviderSession(RestContext context, Locale locale, FileFinder ff, Messages messages, VarResolverSession vr, JsonSchemaGeneratorSession js)	Constructor.

Method Summary

Modifier and Type	Method	Description
OpenApi	getOpenApi()	Generates the OpenAPI 3.1 document.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

BasicOpenApiProviderSession

public BasicOpenApiProviderSession(RestContext context,
 Locale locale,
 FileFinder ff,
 Messages messages,
 VarResolverSession vr,
 JsonSchemaGeneratorSession js)

Constructor.

Parameters:

context - The context of the REST object we're generating an OpenAPI doc for.
Must not be null.

locale - The language of the document we're asking for.

ff - The file finder to use for finding JSON files.

messages - The messages to use for finding localized strings.

vr - The variable resolver to use for resolving variables.

js - The JSON-schema generator to use for stuff like examples.

Method Details

getOpenApi

public OpenApi getOpenApi()
                   throws Exception

Generates the OpenAPI 3.1 document.

Returns:

A new OpenApi object.

Throws:

Exception - If an error occurred producing the document.