org.sdase.commons.server.starter.builder

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

All Superinterfaces:

CustomConfigurationProviders.SwaggerScanningBuilder<C>

All Known Implementing Classes:

SdaPlatformBundle.Builder

Enclosing interface:

CustomConfigurationProviders

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

Method Summary

Modifier and Type	Method and Description
CustomConfigurationProviders.SwaggerDetailsBuilder<C>	disableSwaggerEmbedParameter() Disables automatic addition of the embed query parameter if embeddable resources are discovered.
CustomConfigurationProviders.SwaggerDetailsBuilder<C>	disableSwaggerJsonExamples() Disables automatic rendering of Json examples in Swagger property examples and response examples.
default CustomConfigurationProviders.SwaggerDetailsBuilder<C>	withSwaggerInfoContact(java.lang.String name) Sets the contact of the API.
default CustomConfigurationProviders.SwaggerDetailsBuilder<C>	withSwaggerInfoContact(java.lang.String name, java.lang.String email) Sets the contact of the API.
CustomConfigurationProviders.SwaggerDetailsBuilder<C>	withSwaggerInfoContact(java.lang.String name, java.lang.String email, java.lang.String url) Sets the contact of the API.
CustomConfigurationProviders.SwaggerDetailsBuilder<C>	withSwaggerInfoDescription(java.lang.String description) Sets the description of the API.
default CustomConfigurationProviders.SwaggerDetailsBuilder<C>	withSwaggerInfoLicense(java.lang.String name) Sets the license of the API.
CustomConfigurationProviders.SwaggerDetailsBuilder<C>	withSwaggerInfoLicense(java.lang.String name, java.lang.String url) Sets the license of the API.
CustomConfigurationProviders.SwaggerDetailsBuilder<C>	withSwaggerInfoTermsOfServiceUrl(java.lang.String termsOfServiceUrl) Sets the Terms of Service URL of the API.
CustomConfigurationProviders.SwaggerDetailsBuilder<C>	withSwaggerInfoVersion(java.lang.String version) Sets the version of the API.

Methods inherited from interface org.sdase.commons.server.starter.builder.CustomConfigurationProviders.SwaggerScanningBuilder

addSwaggerResourcePackage, addSwaggerResourcePackageClass

Method Detail

disableSwaggerEmbedParameter

CustomConfigurationProviders.SwaggerDetailsBuilder<C> disableSwaggerEmbedParameter()

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

Returns:

the builder.

disableSwaggerJsonExamples

CustomConfigurationProviders.SwaggerDetailsBuilder<C> disableSwaggerJsonExamples()

Disables automatic rendering of Json examples in Swagger property examples and response examples. If disabled, only String and Integer are recognized as special types.

Returns:

the builder

withSwaggerInfoVersion

CustomConfigurationProviders.SwaggerDetailsBuilder<C> withSwaggerInfoVersion(java.lang.String version)

Sets the version of the API.

Note: If no version is given (i.e. this method is not used) 1.0 is used.

Parameters:

version - the version; not null or empty

Returns:

the builder

Throws:

java.lang.NullPointerException - if version is null

java.lang.IllegalArgumentException - if version is empty

See Also:

Swagger's BeanConfig

withSwaggerInfoDescription

CustomConfigurationProviders.SwaggerDetailsBuilder<C> withSwaggerInfoDescription(java.lang.String description)

Sets the description of the API.

Parameters:

description - the description; not null or empty

Returns:

the builder

Throws:

java.lang.NullPointerException - if description is null

java.lang.IllegalArgumentException - if description is empty

See Also:

Swagger's BeanConfig

withSwaggerInfoTermsOfServiceUrl

CustomConfigurationProviders.SwaggerDetailsBuilder<C> withSwaggerInfoTermsOfServiceUrl(java.lang.String termsOfServiceUrl)

Sets the Terms of Service URL of the API.

Parameters:

termsOfServiceUrl - the Terms of Service URL; not null or empty

Returns:

the builder

Throws:

java.lang.NullPointerException - if termsOfServiceUrl is null

java.lang.IllegalArgumentException - if termsOfServiceUrl is empty

See Also:

Swagger's BeanConfig

withSwaggerInfoContact

default CustomConfigurationProviders.SwaggerDetailsBuilder<C> withSwaggerInfoContact(java.lang.String name)

Sets the contact of the API.

Parameters:

name - the contact's name; not null or empty

Returns:

the builder

Throws:

java.lang.NullPointerException - if name is null

java.lang.IllegalArgumentException - if name is empty

See Also:

Swagger's BeanConfig

withSwaggerInfoContact

default CustomConfigurationProviders.SwaggerDetailsBuilder<C> withSwaggerInfoContact(java.lang.String name,
                                                                                     java.lang.String email)

Sets the contact of the API.

Parameters:

name - the contact's name; not null or empty

email - the contact's email; not null or empty

Returns:

the builder

Throws:

java.lang.NullPointerException - if name or email is null

java.lang.IllegalArgumentException - if name or email is empty

See Also:

Swagger's BeanConfig

withSwaggerInfoContact

CustomConfigurationProviders.SwaggerDetailsBuilder<C> withSwaggerInfoContact(java.lang.String name,
                                                                             java.lang.String email,
                                                                             java.lang.String url)

Sets the contact of the API.

Parameters:

name - the contact's name; not null or empty

email - the contact's email; not null or empty

url - the contact's url; not null or empty

Returns:

the builder

Throws:

java.lang.NullPointerException - if name, email, or url is null

java.lang.IllegalArgumentException - if name, email, or url is empty

See Also:

Swagger's BeanConfig

withSwaggerInfoLicense

default CustomConfigurationProviders.SwaggerDetailsBuilder<C> withSwaggerInfoLicense(java.lang.String name)

Sets the license of the API.

Parameters:

name - the license's name; not null or empty

Returns:

the builder

Throws:

java.lang.NullPointerException - if name is null

java.lang.IllegalArgumentException - if name is empty

See Also:

Swagger's BeanConfig

withSwaggerInfoLicense

CustomConfigurationProviders.SwaggerDetailsBuilder<C> withSwaggerInfoLicense(java.lang.String name,
                                                                             java.lang.String url)

Sets the license of the API.

Parameters:

name - the license's name; not null or empty

url - the license's url; not null or empty

Returns:

the builder

Throws:

java.lang.NullPointerException - if name or url is null

java.lang.IllegalArgumentException - if name or url is empty

See Also:

Swagger's BeanConfig