Module io.helidon.openapi

Package io.helidon.openapi

Class OpenApiFeature

java.lang.Object

io.helidon.openapi.OpenApiFeature

All Implemented Interfaces:

io.helidon.builder.api.RuntimeType.Api<OpenApiFeatureConfig>, NamedService, ServerFeature

public final class OpenApiFeature
extends Object
implements ServerFeature, io.helidon.builder.api.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()
OpenApiFeatureConfig	prototype()
void	setup(ServerFeature.ServerFeatureContext featureContext)
String	type()

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()

Specified by:

prototype in interface io.helidon.builder.api.RuntimeType.Api<OpenApiFeatureConfig>

setup

public void setup(ServerFeature.ServerFeatureContext featureContext)

Specified by:

setup in interface ServerFeature

name

public String name()

Specified by:

name in interface NamedService

type

public String type()

Specified by:

type in interface NamedService

initialize

public void initialize()

Initialize the model.