Module io.helidon.openapi

Package io.helidon.openapi

Class OpenAPISupport.Builder<B extends OpenAPISupport.Builder<B>>

java.lang.Object

io.helidon.openapi.OpenAPISupport.Builder<B>

Type Parameters:

B - concrete subclass of OpenAPISupport.Builder

All Implemented Interfaces:

Builder<OpenAPISupport>, Supplier<OpenAPISupport>

Direct Known Subclasses:

MPOpenAPIBuilder, SEOpenAPISupportBuilder

Enclosing class:

OpenAPISupport

public abstract static class OpenAPISupport.Builder<B extends OpenAPISupport.Builder<B>>
extends Object
implements Builder<OpenAPISupport>

Fluent API builder for OpenAPISupport.

This abstract implementation is extended once for use by developers from Helidon SE apps and once for use from the Helidon MP-provided OpenAPI service. This lets us constrain what use cases are possible from each (for example, no anno processing from SE).

Field Summary

Fields

Modifier and Type	Field	Description
static String	CONFIG_KEY	Config key to select the openapi node from Helidon config.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder(Class<B> builderClass)

Method Summary

Modifier and Type	Method	Description
B	config(Config config)	Set various builder attributes from the specified Config object.
B	crossOriginConfig(CrossOriginConfig crossOriginConfig)	Set the CORS config from the specified CrossOriginConfig object.
protected Supplier<List<? extends org.jboss.jandex.IndexView>>	indexViewsSupplier()
protected B	me()
abstract io.smallrye.openapi.api.OpenApiConfig	openAPIConfig()	Returns the smallrye OpenApiConfig instance describing the set-up that will govern the smallrye OpenAPI behavior.
B	staticFile(String path)	Sets the location of the static OpenAPI document file.
B	ui(OpenApiUi.Builder<?,?> uiBuilder)	Assigns the OpenAPI UI builder the OpenAPISupport service should use in preparing the UI.
void	validate()	Makes sure the set-up for OpenAPI is consistent, internally and with the current Helidon runtime environment (SE or MP).
B	webContext(String path)	Path under which to register OpenAPI endpoint on the web server.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.helidon.common.Builder

build, get

Field Detail

CONFIG_KEY

public static final String CONFIG_KEY

Config key to select the openapi node from Helidon config.

See Also:

Constant Field Values

Constructor Detail

Builder

protected Builder(Class<B> builderClass)

Method Detail

me

protected B me()

config

public B config(Config config)

Set various builder attributes from the specified Config object.

The Config object can specify web-context and static-file in addition to settings supported by OpenAPIConfigImpl.Builder.

Parameters:

config - the openapi Config object possibly containing settings

Returns:

updated builder instance

Throws:

NullPointerException - if the provided Config is null

openAPIConfig

public abstract io.smallrye.openapi.api.OpenApiConfig openAPIConfig()

Returns the smallrye OpenApiConfig instance describing the set-up that will govern the smallrye OpenAPI behavior.

Returns:

OpenApiConfig conveying how OpenAPI should behave

validate

public void validate()
              throws IllegalStateException

Makes sure the set-up for OpenAPI is consistent, internally and with the current Helidon runtime environment (SE or MP).

Throws:

IllegalStateException - if validation fails

webContext

public B webContext(String path)

Path under which to register OpenAPI endpoint on the web server.

Parameters:

path - webContext to use, defaults to "/openapi"

Returns:

updated builder instance

staticFile

public B staticFile(String path)

Sets the location of the static OpenAPI document file.

Parameters:

path - non-null location of the static OpenAPI document file

Returns:

updated builder instance

crossOriginConfig

public B crossOriginConfig(CrossOriginConfig crossOriginConfig)

Set the CORS config from the specified CrossOriginConfig object.

Parameters:

crossOriginConfig - CrossOriginConfig containing CORS set-up

Returns:

updated builder instance

ui

public B ui(OpenApiUi.Builder<?,?> uiBuilder)

Assigns the OpenAPI UI builder the OpenAPISupport service should use in preparing the UI.

Parameters:

uiBuilder - the OpenApiUi.Builder

Returns:

updated builder instance

indexViewsSupplier

protected Supplier<List<? extends org.jboss.jandex.IndexView>> indexViewsSupplier()