Module io.helidon.openapi

Package io.helidon.openapi

Interface OpenApiUi

All Superinterfaces:

Service

All Known Implementing Classes:

OpenApiUiBase

public interface OpenApiUi
extends Service

Behavior for OpenAPI UI implementations.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	OpenApiUi.Builder<B extends OpenApiUi.Builder<B,T>,T extends OpenApiUi>	Builder for an OpenApiUi.

Field Summary

Fields

Modifier and Type	Field	Description
static String	UI_WEB_SUBCONTEXT	Default subcontext within the OpenAPISupport instance's web context (which itself defaults to "/openapi".

Method Summary

Modifier and Type	Method	Description
static OpenApiUi.Builder<?,?>	builder()	Creates a builder for a new OpenApiUi instance.
boolean	prepareTextResponseFromMainEndpoint(ServerRequest request, ServerResponse response)	Gives the UI an opportunity to respond to a request arriving at the OpenAPISupport endpoint for which the best-accepted MediaType was text/html.
MediaType[]	supportedMediaTypes()	Indicates the media types the UI implementation itself supports.

Methods inherited from interface io.helidon.webserver.Service

update

Field Detail

UI_WEB_SUBCONTEXT

static final String UI_WEB_SUBCONTEXT

Default subcontext within the OpenAPISupport instance's web context (which itself defaults to "/openapi".

See Also:

Constant Field Values

Method Detail

builder

static OpenApiUi.Builder<?,?> builder()

Creates a builder for a new OpenApiUi instance.

Returns:

new builder

supportedMediaTypes

MediaType[] supportedMediaTypes()

Indicates the media types the UI implementation itself supports.

Returns:

the media types the prepareTextResponseFromMainEndpoint(io.helidon.webserver.ServerRequest, io.helidon.webserver.ServerResponse) method responds to

prepareTextResponseFromMainEndpoint

boolean prepareTextResponseFromMainEndpoint(ServerRequest request,
                                            ServerResponse response)

Gives the UI an opportunity to respond to a request arriving at the OpenAPISupport endpoint for which the best-accepted MediaType was text/html.

An implementation should return true if it is responsible for a particular media type whether it handled the request itself or delegated the request to the next handler. For example, even if the implementation is disabled it should still return true for the HTML media type.

Parameters:

request - the request for HTML content

response - the response which could be prepared and sent

Returns:

whether the UI did respond to the request