org.sdase.commons.server.openapi

Class OpenApiBundle.Builder

java.lang.Object

org.sdase.commons.server.openapi.OpenApiBundle.Builder

All Implemented Interfaces:

OpenApiBundle.FinalBuilder, OpenApiBundle.InitialBuilder

Enclosing class:

OpenApiBundle

public static final class OpenApiBundle.Builder
extends java.lang.Object
implements OpenApiBundle.InitialBuilder, OpenApiBundle.FinalBuilder

Method Summary

Modifier and Type	Method and Description
OpenApiBundle.Builder	addResourcePackage(java.lang.String resourcePackage) Adds a package to the packages Swagger should scan to pick up resources.
OpenApiBundle.Builder	addResourcePackageClass(java.lang.Class<?> resourcePackageClass) Adds the package of the given class to the packages Swagger should scan to pick up resources.
OpenApiBundle	build()
OpenApiBundle.FinalBuilder	disableEmbedParameter() Disables automatic addition of the embed query parameter if embeddable resources are discovered.
OpenApiBundle.Builder	withExistingOpenAPI(java.lang.String openApiJsonOrYaml) Use an existing OpenAPI 3 specification as base for the generation.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.sdase.commons.server.openapi.OpenApiBundle.InitialBuilder

withExistingOpenAPIFromClasspathResource

Method Detail

disableEmbedParameter

public OpenApiBundle.FinalBuilder disableEmbedParameter()

Description copied from interface: OpenApiBundle.FinalBuilder

Disables automatic addition of the embed query parameter if embeddable resources are discovered.

Specified by:

disableEmbedParameter in interface OpenApiBundle.FinalBuilder

Returns:

the builder.

addResourcePackage

public OpenApiBundle.Builder addResourcePackage(java.lang.String resourcePackage)

Description copied from interface: OpenApiBundle.InitialBuilder

Adds a package to the packages Swagger should scan to pick up resources.

Specified by:

addResourcePackage in interface OpenApiBundle.InitialBuilder

Parameters:

resourcePackage - the package to be scanned; not null

Returns:

the builder

See Also:

Swagger's BeanConfig

addResourcePackageClass

public OpenApiBundle.Builder addResourcePackageClass(java.lang.Class<?> resourcePackageClass)

Description copied from interface: OpenApiBundle.InitialBuilder

Adds the package of the given class to the packages Swagger should scan to pick up resources.

Specified by:

addResourcePackageClass in interface OpenApiBundle.InitialBuilder

Parameters:

resourcePackageClass - the class whose package should be scanned; not null

Returns:

the builder

See Also:

Swagger's BeanConfig

withExistingOpenAPI

public OpenApiBundle.Builder withExistingOpenAPI(java.lang.String openApiJsonOrYaml)

Description copied from interface: OpenApiBundle.InitialBuilder

Use an existing OpenAPI 3 specification as base for the generation.

Note that the OpenAPI annotations always override values from the files if classes are registered with OpenApiBundle.InitialBuilder.addResourcePackage(String) or OpenApiBundle.InitialBuilder.addResourcePackageClass(Class).

The postprocessing will also be done for these files, including sorting, embed parameter, and server baseurl.

Specified by:

withExistingOpenAPI in interface OpenApiBundle.InitialBuilder

Parameters:

openApiJsonOrYaml - the OpenAPI 3 specification as json or yaml

Returns:

the builder

See Also:

EmbedParameterModifier, SorterModifier, ServerUrlFilter

build

public OpenApiBundle build()

Specified by:

build in interface OpenApiBundle.FinalBuilder