Package io.helidon.openapi

Class OpenAPISupport.Builder

java.lang.Object

io.helidon.openapi.OpenAPISupport.Builder

All Implemented Interfaces:

Builder<OpenAPISupport>, Supplier<OpenAPISupport>

Direct Known Subclasses:

MPOpenAPIBuilder, SEOpenAPISupportBuilder

Enclosing class:

OpenAPISupport

public abstract static class OpenAPISupport.Builder
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 for locating openapi settings within a Helidon config object.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
OpenAPISupport	build()	Build the instance from this builder.
OpenAPISupport.Builder	config(Config config)	Set various builder attributes from the specified openapi Config object.
OpenAPISupport.Builder	helidonConfig(Config config)	Deprecated.
abstract org.jboss.jandex.IndexView	indexView()	Returns the Jandex IndexView containing annotated endpoint classes.
abstract io.smallrye.openapi.api.OpenApiConfig	openAPIConfig()	Returns the smallrye OpenApiConfig instance describing the set-up that will govern the smallrye OpenAPI behavior.
OpenAPISupport.Builder	staticFile(String path)	Sets the location of the static OpenAPI document file.
void	validate()	Makes sure the set-up for OpenAPI is consistent, internally and with the current Helidon runtime environment (SE or MP).
OpenAPISupport.Builder	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

get

Field Detail

CONFIG_KEY

public static final String CONFIG_KEY

Config key for locating openapi settings within a Helidon config object.

See Also:

Constant Field Values

Constructor Detail

Builder

public Builder()

Method Detail

build

public OpenAPISupport build()

Description copied from interface: Builder

Build the instance from this builder.

Specified by:

build in interface Builder<OpenAPISupport>

Returns:

instance of the built type

helidonConfig

@Deprecated
public OpenAPISupport.Builder helidonConfig(Config config)

Deprecated.

Set various builder attributes from the specified Config object.

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

Parameters:

config - the Config object possibly containing settings

Returns:

updated builder instance

Throws:

NullPointerException - if the provided Config is null

config

public OpenAPISupport.Builder config(Config config)

Set various builder attributes from the specified openapi 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

indexView

public abstract org.jboss.jandex.IndexView indexView()

Returns the Jandex IndexView containing annotated endpoint classes.

Returns:

IndexView containing endpoint classes

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 OpenAPISupport.Builder 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 OpenAPISupport.Builder 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