org.sdase.commons.server.starter.builder

Interface CustomConfigurationProviders.SwaggerTitleBuilder<C extends io.dropwizard.Configuration>

All Known Subinterfaces:

CustomConfigurationProviders.ConsumerTokenRequiredConfigBuilder<C>

All Known Implementing Classes:

SdaPlatformBundle.Builder

Enclosing interface:

CustomConfigurationProviders

public static interface CustomConfigurationProviders.SwaggerTitleBuilder<C extends io.dropwizard.Configuration>

Method Summary

Modifier and Type	Method and Description
PlatformBundleBuilder<C>	withoutSwagger() Deprecated. If you want to use the OpenApiBundle, use the sda-commons-starter module instead. You will get dependency conflicts when importing both sda-commons-server-starter and sda-commons-server-openapi.
CustomConfigurationProviders.SwaggerDetailsBuilder<C>	withSwaggerInfoTitle(java.lang.String title) Sets the title of the API in the swagger documentation.

Method Detail

withoutSwagger

@Deprecated
PlatformBundleBuilder<C> withoutSwagger()

Deprecated. If you want to use the OpenApiBundle, use the sda-commons-starter module instead. You will get dependency conflicts when importing both sda-commons-server-starter and sda-commons-server-openapi.

Disables the Swagger support for this application. This is useful if the SwaggerBundle should be configured manually of if the OpenApiBundle is used instead.

Returns:

the builder

withSwaggerInfoTitle

CustomConfigurationProviders.SwaggerDetailsBuilder<C> withSwaggerInfoTitle(java.lang.String title)

Sets the title of the API in the swagger documentation.

Parameters:

title - the title; not null or empty

Returns:

the builder

Throws:

java.lang.NullPointerException - if title is null

java.lang.IllegalArgumentException - if title is empty

See Also:

Swagger's BeanConfig