Module io.helidon.integrations.openapi.ui

Package io.helidon.integrations.openapi.ui

Class OpenApiUi

java.lang.Object

io.helidon.integrations.openapi.ui.OpenApiUi

All Implemented Interfaces:

RuntimeType.Api<OpenApiUiConfig>, NamedService, NamedService, OpenApiService

public final class OpenApiUi
extends Object
implements OpenApiService, RuntimeType.Api<OpenApiUiConfig>

An OpenApiService that serves OpenApi UI.

Method Summary

Modifier and Type	Method	Description
static OpenApiUiConfig.Builder	builder()	Returns a new builder.
static OpenApiUi	create()	Create a new instance with default configuration.
static OpenApiUi	create(Consumer<OpenApiUiConfig.Builder> builderConsumer)	Create a new instance with custom configuration.
String	name()	Name of this implementation, as provided in ConfiguredProvider.create(io.helidon.common.config.Config, String).
OpenApiUiConfig	prototype()	The prototype as it was received when creating this runtime object instance.
void	setup(HttpRules rules, String docPath, Function<MediaType,String> content)	Set up the service.
boolean	supports(ServerRequestHeaders headers)	Test if the service should handle a request.
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 OpenApiUiConfig.Builder builder()

Returns a new builder.

Returns:

new builder

create

public static OpenApiUi create()

Create a new instance with default configuration.

Returns:

new instance

create

public static OpenApiUi create(Consumer<OpenApiUiConfig.Builder> builderConsumer)

Create a new instance with custom configuration.

Parameters:

builderConsumer - consumer of configuration builder

Returns:

new instance

prototype

public OpenApiUiConfig 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<OpenApiUiConfig>

Returns:

prototype object used to create this instance

name

public String name()

Description copied from interface: NamedService

Name of this implementation, as provided in ConfiguredProvider.create(io.helidon.common.config.Config, String).

Specified by:

name in interface NamedService

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

Specified by:

type in interface NamedService

Returns:

type of this service

supports

public boolean supports(ServerRequestHeaders headers)

Description copied from interface: OpenApiService

Test if the service should handle a request.

Specified by:

supports in interface OpenApiService

Parameters:

headers - headers

Returns:

true if the service should handle the request

setup

public void setup(HttpRules rules,
 String docPath,
 Function<MediaType,String> content)

Description copied from interface: OpenApiService

Set up the service.

Specified by:

setup in interface OpenApiService

Parameters:

rules - routing

docPath - document context path

content - content function