Module io.helidon.openapi

Package io.helidon.openapi

Class OpenApiFeature

java.lang.Object

io.helidon.openapi.OpenApiFeature

All Implemented Interfaces:

RuntimeType.Api<OpenApiFeatureConfig>, NamedService, ServerFeature

public final class OpenApiFeature
extends Object
implements ServerFeature, RuntimeType.Api<OpenApiFeatureConfig>

Helidon Support for OpenAPI.

Nested Class Summary

Nested classes/interfaces inherited from interface io.helidon.webserver.spi.ServerFeature

ServerFeature.RoutingBuilders, ServerFeature.ServerFeatureContext, ServerFeature.SocketBuilders

Method Summary

Modifier and Type	Method	Description
static OpenApiFeatureConfig.Builder	builder()	Returns a new builder.
static OpenApiFeature	create()	Create a new instance with default configuration.
static OpenApiFeature	create(Config config)	Create a new instance from typed configuration.
static OpenApiFeature	create(Consumer<OpenApiFeatureConfig.Builder> builderConsumer)	Create a new instance with custom configuration.
void	initialize()	Initialize the model.
String	name()	Name of this implementation, as provided in ConfiguredProvider.create(Config, String).
OpenApiFeatureConfig	prototype()	The prototype as it was received when creating this runtime object instance.
void	setup(ServerFeature.ServerFeatureContext featureContext)	Set up a server feature.
String	type()	Type of this implementation, to distinguish instances of same type, with different NamedService.name().

Methods inherited from class java.lang.Object

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

Method Details

builder

public static OpenApiFeatureConfig.Builder builder()

Returns a new builder.

Returns:

new builder`

create

public static OpenApiFeature create()

Create a new instance with default configuration.

Returns:

new instance

create

public static OpenApiFeature create(Config config)

Create a new instance from typed configuration.

Parameters:

config - typed configuration

Returns:

new instance

create

public static OpenApiFeature create(Consumer<OpenApiFeatureConfig.Builder> builderConsumer)

Create a new instance with custom configuration.

Parameters:

builderConsumer - consumer of configuration builder

Returns:

new instance

prototype

public OpenApiFeatureConfig prototype()

Description copied from interface: RuntimeType.Api

The prototype as it was received when creating this runtime object instance.

Specified by:

prototype in interface RuntimeType.Api<OpenApiFeatureConfig>

Returns:

prototype object used to create this instance

setup

public void setup(ServerFeature.ServerFeatureContext featureContext)

Description copied from interface: ServerFeature

Set up a server feature. Server features can modify server configuration, right before the server is created. To access listener configuration, or routing, a list of all listeners is provided.

Specified by:

setup in interface ServerFeature

Parameters:

featureContext - to access builders of webserver, listeners, and routing

name

public String name()

Description copied from interface: NamedService

Name of this implementation, as provided in ConfiguredProvider.create(Config, String).

Specified by:

name in interface NamedService

Returns:

name of this service

type

public String type()

Description copied from interface: NamedService

Type of this implementation, to distinguish instances of same type, with different NamedService.name(). Use for example ConfiguredProvider.configKey() to define the type.

Specified by:

type in interface NamedService

Returns:

type of this service

initialize

public void initialize()

Initialize the model.