Package io.helidon.microprofile.openapi
Class MPOpenAPIBuilder
java.lang.Object
io.helidon.nima.openapi.OpenApiService.AbstractBuilder<MPOpenAPIBuilder,io.helidon.microprofile.openapi.MPOpenAPISupport>
io.helidon.microprofile.openapi.MPOpenAPIBuilder
- All Implemented Interfaces:
Builder<MPOpenAPIBuilder,,io.helidon.microprofile.openapi.MPOpenAPISupport> Supplier<io.helidon.microprofile.openapi.MPOpenAPISupport>
public final class MPOpenAPIBuilder
extends OpenApiService.AbstractBuilder<MPOpenAPIBuilder,io.helidon.microprofile.openapi.MPOpenAPISupport>
Fluent builder for OpenAPISupport in Helidon MP.
-
Field Summary
Fields inherited from class io.helidon.nima.openapi.OpenApiService.AbstractBuilder
CONFIG_KEY -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionio.helidon.microprofile.openapi.MPOpenAPISupportbuild()Build the instance from this builder.Assigns various OpenAPI settings from the specified MP OpenAPIConfigobject.Returns the supplier of index views.protected io.smallrye.openapi.api.OpenApiConfigReturns the smallrye OpenApiConfig instance describing the set-up that will govern the smallrye OpenAPI behavior.validate()Makes sure the set-up for OpenAPI is consistent, internally and with the current Helidon runtime environment (SE or MP).Methods inherited from class io.helidon.nima.openapi.OpenApiService.AbstractBuilder
addOperationServer, addPathServer, config, crossOriginConfig, filter, modelReader, servers, staticFile, webContext
-
Constructor Details
-
MPOpenAPIBuilder
public MPOpenAPIBuilder()
-
-
Method Details
-
openAPIConfig
protected io.smallrye.openapi.api.OpenApiConfig openAPIConfig()Description copied from class:OpenApiService.AbstractBuilderReturns the smallrye OpenApiConfig instance describing the set-up that will govern the smallrye OpenAPI behavior.- Overrides:
openAPIConfigin classOpenApiService.AbstractBuilder<MPOpenAPIBuilder,io.helidon.microprofile.openapi.MPOpenAPISupport> - Returns:
OpenApiConfigconveying how OpenAPI should behave
-
build
public io.helidon.microprofile.openapi.MPOpenAPISupport build()Description copied from interface:BuilderBuild the instance from this builder.- Returns:
- instance of the built type
-
config
Assigns various OpenAPI settings from the specified MP OpenAPIConfigobject.- Parameters:
mpConfig- the OpenAPIConfigobject possibly containing settings- Returns:
- updated builder instance
-
indexViewsSupplier
Description copied from class:OpenApiService.AbstractBuilderReturns the supplier of index views.- Overrides:
indexViewsSupplierin classOpenApiService.AbstractBuilder<MPOpenAPIBuilder,io.helidon.microprofile.openapi.MPOpenAPISupport> - Returns:
- index views supplier
-
validate
Description copied from class:OpenApiService.AbstractBuilderMakes sure the set-up for OpenAPI is consistent, internally and with the current Helidon runtime environment (SE or MP).- Overrides:
validatein classOpenApiService.AbstractBuilder<MPOpenAPIBuilder,io.helidon.microprofile.openapi.MPOpenAPISupport> - Returns:
- this builder
- Throws:
IllegalStateException- if validation fails
-