Module io.helidon.microprofile.openapi

Package io.helidon.microprofile.openapi

Class MPOpenAPIBuilder

java.lang.Object

io.helidon.openapi.OpenAPISupport.Builder

io.helidon.microprofile.openapi.MPOpenAPIBuilder

All Implemented Interfaces:

Builder<OpenAPISupport>, Supplier<OpenAPISupport>

public final class MPOpenAPIBuilder
extends OpenAPISupport.Builder

Fluent builder for OpenAPISupport in Helidon MP.

Field Summary

Fields inherited from class io.helidon.openapi.OpenAPISupport.Builder

CONFIG_KEY

Constructor Summary

Constructors

Constructor	Description
MPOpenAPIBuilder()

Method Summary

Modifier and Type	Method	Description
MPOpenAPIBuilder	indexView(org.jboss.jandex.IndexView indexView)	Sets the IndexView instance to be passed to the smallrye OpenApi impl for annotation analysis.
io.smallrye.openapi.api.OpenApiConfig	openAPIConfig()	Returns the smallrye OpenApiConfig instance describing the set-up that will govern the smallrye OpenAPI behavior.
List<io.smallrye.openapi.runtime.scanner.FilteredIndexView>	perAppFilteredIndexViews()	Returns zero or more FilteredIndexView instances, each of which to be used in constructing an OpenAPI model that is merged with the others.
void	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.openapi.OpenAPISupport.Builder

build, config, crossOriginConfig, 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

Constructor Detail

MPOpenAPIBuilder

public MPOpenAPIBuilder()

Method Detail

openAPIConfig

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

Description copied from class: OpenAPISupport.Builder

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

Specified by:

openAPIConfig in class OpenAPISupport.Builder

Returns:

OpenApiConfig conveying how OpenAPI should behave

perAppFilteredIndexViews

public List<io.smallrye.openapi.runtime.scanner.FilteredIndexView> perAppFilteredIndexViews()

Description copied from class: OpenAPISupport.Builder

Returns zero or more FilteredIndexView instances, each of which to be used in constructing an OpenAPI model that is merged with the others. This is particularly useful for supporting multiple Application instances in a single server.

Specified by:

perAppFilteredIndexViews in class OpenAPISupport.Builder

Returns:

possibly empty List of FilteredIndexView objects

indexView

public MPOpenAPIBuilder indexView(org.jboss.jandex.IndexView indexView)

Sets the IndexView instance to be passed to the smallrye OpenApi impl for annotation analysis.

Parameters:

indexView - IndexView instance containing endpoint classes

Returns:

updated builder instance

validate

public void validate()
              throws IllegalStateException

Description copied from class: OpenAPISupport.Builder

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

Overrides:

validate in class OpenAPISupport.Builder

Throws:

IllegalStateException - if validation fails