Package io.helidon.openapi

Class OpenAPISupport

java.lang.Object

io.helidon.openapi.OpenAPISupport

All Implemented Interfaces:

Service

public class OpenAPISupport
extends Object
implements Service

Provides an endpoint and supporting logic for returning an OpenAPI document that describes the endpoints handled by the application.

The application can use the OpenAPISupport.Builder to set OpenAPI-related attributes, including:

OpenAPI-related Settings

Method on OpenAPISupport.Builder	Purpose
OpenAPISupport.Builder.config(io.helidon.config.Config)	sets multiple OpenAPI-related items from a Config object
OpenAPISupport.Builder.staticFile(java.lang.String)	sets the static OpenAPI document file (defaults in order to openapi.yaml, openapi.yml, or openapi.json)
OpenAPISupport.Builder.enableAnnotationProcessing(boolean)	sets whether OpenAPI annotations should be processed
OpenAPISupport.Builder.webContext	sets the endpoint path that will serve the OpenAPI document
OpenAPISupport.Builder.modelReader(java.lang.String)	sets the application-provided class for adding to the OpenAPI document
OpenAPISupport.Builder.filter(java.lang.String)	sets the application-provided class for filtering OpenAPI document information
OpenAPISupport.Builder.servers(java.lang.String)	sets the servers to be reported in the OpenAPI document
OpenAPISupport.Builder.addOperationServer(java.lang.String, java.lang.String)	associates a server with a given operation ID
OpenAPISupport.Builder.addPathServer(java.lang.String, java.lang.String)	associates a server with a given path

If the application uses none of these builder methods and does not provide a static openapi file, then the /openapi endpoint responds with a nearly-empty OpenAPI document.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OpenAPISupport.Builder Fluent API builder for OpenAPISupport.

Field Summary

Fields

Modifier and Type	Field and Description
static io.helidon.common.http.MediaType	DEFAULT_RESPONSE_MEDIA_TYPE Default media type used in responses in absence of incoming Accept header.
static String	DEFAULT_WEB_CONTEXT Default path for serving the OpenAPI document.

Method Summary

Modifier and Type	Method and Description
static OpenAPISupport.Builder	builder() Creates a new OpenAPISupport.Builder for OpenAPISupport using defaults.
static OpenAPISupport	create() Creates a new OpenAPISupport instance using defaults.
static OpenAPISupport	create(Config config) Creates a new OpenAPISupport instance using the '' portion of the provided Config object.
void	update(Routing.Rules rules)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_WEB_CONTEXT

public static final String DEFAULT_WEB_CONTEXT

Default path for serving the OpenAPI document.

See Also:

Constant Field Values

DEFAULT_RESPONSE_MEDIA_TYPE

public static final io.helidon.common.http.MediaType DEFAULT_RESPONSE_MEDIA_TYPE

Default media type used in responses in absence of incoming Accept header.

Method Detail

update

public void update(Routing.Rules rules)

Specified by:

update in interface Service

builder

public static OpenAPISupport.Builder builder()

Creates a new OpenAPISupport.Builder for OpenAPISupport using defaults.

Returns:

new Builder

create

public static OpenAPISupport create()

Creates a new OpenAPISupport instance using defaults.

Returns:

new OpenAPISUpport

create

public static OpenAPISupport create(Config config)

Creates a new OpenAPISupport instance using the '' portion of the provided Config object.

Parameters:

config - Config object containing OpenAPI-related settings

Returns:

new OpenAPISupport instance created using the config settings