Module io.helidon.openapi
Package io.helidon.openapi
Helidon SE OpenAPI Support.
Use OpenAPISupport
and its Builder
to include support for
OpenAPI in your application.
Because Helidon SE does not use annotation processing to identify endpoints, you need to provide the OpenAPI information for your application yourself. You can provide a static OpenAPI document or you can implement and specify your own model processing class that provides the data needed to build the OpenAPI document.
-
Interface Summary Interface Description OpenApiUi Behavior for OpenAPI UI implementations.OpenApiUi.Builder<B extends OpenApiUi.Builder<B,T>,T extends OpenApiUi> Builder for anOpenApiUi
.OpenApiUiFactory<B extends OpenApiUi.Builder<B,T>,T extends OpenApiUi> Behavior for factories able to provide new builders ofOpenApiUi
instances. -
Class Summary Class Description OpenAPISupport Provides an endpoint and supporting logic for returning an OpenAPI document that describes the endpoints handled by the server.OpenAPISupport.Builder<B extends OpenAPISupport.Builder<B>> Fluent API builder forOpenAPISupport
.OpenApiUiBase Common base class for implementations of @link OpenApiUi}.OpenApiUiBase.Builder<B extends OpenApiUiBase.Builder<B,T>,T extends OpenApiUi> Common base builder implementation for creating a newOpenApiUi
.OpenApiUiNoOpFactory Factory providing builders forOpenApiUiNoOp
implementations.SEOpenAPISupportBuilder BuildsOpenAPISupport
in a Helidon SE environment.