Module io.helidon.microprofile.openapi

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

Constructor	Description
MPOpenAPIBuilder()

Method Summary

Modifier and Type	Method	Description
io.helidon.microprofile.openapi.MPOpenAPISupport	build()	Build the instance from this builder.
MPOpenAPIBuilder	config(Config mpConfig)	Assigns various OpenAPI settings from the specified MP OpenAPI Config object.
protected Supplier<List<? extends org.jboss.jandex.IndexView>>	indexViewsSupplier()	Returns the supplier of index views.
protected io.smallrye.openapi.api.OpenApiConfig	openAPIConfig()	Returns the smallrye OpenApiConfig instance describing the set-up that will govern the smallrye OpenAPI behavior.
MPOpenAPIBuilder	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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.helidon.common.Builder

get, identity, update

Constructor Details

MPOpenAPIBuilder

public MPOpenAPIBuilder()

Method Details

openAPIConfig

protected io.smallrye.openapi.api.OpenApiConfig openAPIConfig()

Description copied from class: OpenApiService.AbstractBuilder

Returns the smallrye OpenApiConfig instance describing the set-up that will govern the smallrye OpenAPI behavior.

Overrides:

openAPIConfig in class OpenApiService.AbstractBuilder<MPOpenAPIBuilder,io.helidon.microprofile.openapi.MPOpenAPISupport>

Returns:

OpenApiConfig conveying how OpenAPI should behave

build

public io.helidon.microprofile.openapi.MPOpenAPISupport build()

Description copied from interface: Builder

Build the instance from this builder.

Returns:

instance of the built type

config

public MPOpenAPIBuilder config(Config mpConfig)

Assigns various OpenAPI settings from the specified MP OpenAPI Config object.

Parameters:

mpConfig - the OpenAPI Config object possibly containing settings

Returns:

updated builder instance

indexViewsSupplier

protected Supplier<List<? extends org.jboss.jandex.IndexView>> indexViewsSupplier()

Description copied from class: OpenApiService.AbstractBuilder

Returns the supplier of index views.

Overrides:

indexViewsSupplier in class OpenApiService.AbstractBuilder<MPOpenAPIBuilder,io.helidon.microprofile.openapi.MPOpenAPISupport>

Returns:

index views supplier

validate

public MPOpenAPIBuilder validate()
                          throws IllegalStateException

Description copied from class: OpenApiService.AbstractBuilder

Makes sure the set-up for OpenAPI is consistent, internally and with the current Helidon runtime environment (SE or MP).

Overrides:

validate in class OpenApiService.AbstractBuilder<MPOpenAPIBuilder,io.helidon.microprofile.openapi.MPOpenAPISupport>

Returns:

this builder

Throws:

IllegalStateException - if validation fails