Package io.helidon.openapi

Class OpenAPISupport.Builder

java.lang.Object

io.helidon.openapi.OpenAPISupport.Builder

All Implemented Interfaces:

io.helidon.common.Builder<OpenAPISupport>, Supplier<OpenAPISupport>

Enclosing class:

OpenAPISupport

public static final class OpenAPISupport.Builder
extends Object
implements io.helidon.common.Builder<OpenAPISupport>

Fluent API builder for OpenAPISupport.

The builder mostly delegates to an instance of OpenAPIConfigImpl.Builder which in turn prepares a smallrye OpenApiConfig which is what the smallrye implementation uses to control its behavior.

If the app invokes both the config(io.helidon.config.Config) method and other methods for setting individual attributes, the latest builder method invoked "wins" in case of conflicts.

Method Summary

Modifier and Type	Method and Description
OpenAPISupport.Builder	addOperationServer(String operationID, String operationServer) Adds an operation server for a given operation ID.
OpenAPISupport.Builder	addPathServer(String path, String pathServer) Adds a path server for a given path.
OpenAPISupport	build()
OpenAPISupport.Builder	config(Config config) Set various builder attributes from the specified Config object.
OpenAPISupport.Builder	enableAnnotationProcessing(boolean isEnabled) Sets whether annotation processing for OpenAPI annotations should be enabled.
OpenAPISupport.Builder	filter(String className) Set the app-provided OpenAPI model filter class.
OpenAPISupport.Builder	modelReader(String className) Sets the app-provided model reader class.
OpenAPISupport.Builder	servers(String serverList) Sets the servers which offer the endpoints in the OpenAPI document.
OpenAPISupport.Builder	staticFile(String path) Sets the location of the static OpenAPI document file.
OpenAPISupport.Builder	webContext(String path) Path under which to register OpenAPI endpoint on the web server.

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

Method Detail

build

public OpenAPISupport build()

Specified by:

build in interface io.helidon.common.Builder<OpenAPISupport>

config

public OpenAPISupport.Builder config(Config config)

Set various builder attributes from the specified Config object.

The Config object can specify .web-context and .static-file in addition to settings supported by OpenAPIConfigImpl.Builder.

Parameters:

config - the Config object possibly containing settings

Returns:

updated builder instance

webContext

public OpenAPISupport.Builder webContext(String path)

Path under which to register OpenAPI endpoint on the web server.

Parameters:

path - webContext to use, defaults to

Returns:

updated builder instance

staticFile

public OpenAPISupport.Builder staticFile(String path)

Sets the location of the static OpenAPI document file.

Parameters:

path - location of the static OpenAPI document file

Returns:

updated builder instance

modelReader

public OpenAPISupport.Builder modelReader(String className)

Sets the app-provided model reader class.

Parameters:

className - name of the model reader class

Returns:

updated builder instance

filter

public OpenAPISupport.Builder filter(String className)

Set the app-provided OpenAPI model filter class.

Parameters:

className - name of the filter class

Returns:

updated builder instance

servers

public OpenAPISupport.Builder servers(String serverList)

Sets the servers which offer the endpoints in the OpenAPI document.

Parameters:

serverList - comma-separated list of servers

Returns:

updated builder instance

addOperationServer

public OpenAPISupport.Builder addOperationServer(String operationID,
                                                 String operationServer)

Adds an operation server for a given operation ID.

Parameters:

operationID - operation ID to which the server corresponds

operationServer - name of the server to add for this operation

Returns:

updated builder instance

addPathServer

public OpenAPISupport.Builder addPathServer(String path,
                                            String pathServer)

Adds a path server for a given path.

Parameters:

path - path to which the server corresponds

pathServer - name of the server to add for this path

Returns:

updated builder instance

enableAnnotationProcessing

public OpenAPISupport.Builder enableAnnotationProcessing(boolean isEnabled)

Sets whether annotation processing for OpenAPI annotations should be enabled.

Parameters:

isEnabled - whether annotation processing should be turned on

Returns:

updated builder instance