org.sdase.commons.server.swagger

Class SwaggerBundle.Builder

java.lang.Object

org.sdase.commons.server.swagger.SwaggerBundle.Builder

All Implemented Interfaces:

SwaggerBundle.FinalBuilder, SwaggerBundle.InitialBuilder, SwaggerBundle.InterimBuilder

Enclosing class:

SwaggerBundle

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

Method Summary

Modifier and Type	Method and Description
SwaggerBundle.FinalBuilder	addResourcePackage(java.lang.String resourcePackage) Adds a package to the packages Swagger should scan to pick up resources.
SwaggerBundle.FinalBuilder	addResourcePackageClass(java.lang.Class<?> resourcePackageClass) Adds the package of the given class to the packages Swagger should scan to pick up resources.
SwaggerBundle	build()
SwaggerBundle.FinalBuilder	disableEmbedParameter() Disables automatic addition of the embed query parameter if embeddable resources are discovered.
SwaggerBundle.FinalBuilder	disableJsonExamples() Disables automatic rendering of Json examples in Swagger property examples and response examples.
SwaggerBundle.FinalBuilder	withContact(java.lang.String name) Sets the contact of the API.
SwaggerBundle.FinalBuilder	withContact(java.lang.String name, java.lang.String email) Sets the contact of the API.
SwaggerBundle.FinalBuilder	withContact(java.lang.String name, java.lang.String email, java.lang.String url) Sets the contact of the API.
SwaggerBundle.FinalBuilder	withDescription(java.lang.String description) Sets the description of the API.
SwaggerBundle.FinalBuilder	withLicense(java.lang.String name) Sets the license of the API.
SwaggerBundle.FinalBuilder	withLicense(java.lang.String name, java.lang.String url) Sets the license of the API.
SwaggerBundle.FinalBuilder	withTermsOfServiceUrl(java.lang.String termsOfServiceUrl) Sets the Terms of Service URL of the API.
SwaggerBundle.InterimBuilder	withTitle(java.lang.String title) Sets the title of the API.
SwaggerBundle.FinalBuilder	withVersion(java.lang.String version) Sets the version of the API.

Methods inherited from class java.lang.Object

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

Method Detail

disableEmbedParameter

public SwaggerBundle.FinalBuilder disableEmbedParameter()

Description copied from interface: SwaggerBundle.FinalBuilder

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

Specified by:

disableEmbedParameter in interface SwaggerBundle.FinalBuilder

Returns:

the builder.

disableJsonExamples

public SwaggerBundle.FinalBuilder disableJsonExamples()

Description copied from interface: SwaggerBundle.FinalBuilder

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

Specified by:

disableJsonExamples in interface SwaggerBundle.FinalBuilder

Returns:

the builder

withTitle

public SwaggerBundle.InterimBuilder withTitle(java.lang.String title)

Description copied from interface: SwaggerBundle.InitialBuilder

Sets the title of the API.

Specified by:

withTitle in interface SwaggerBundle.InitialBuilder

Parameters:

title - the title; not null or empty

Returns:

the builder

See Also:

Swagger's BeanConfig

withVersion

public SwaggerBundle.FinalBuilder withVersion(java.lang.String version)

Description copied from interface: SwaggerBundle.FinalBuilder

Sets the version of the API.

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

Specified by:

withVersion in interface SwaggerBundle.FinalBuilder

Parameters:

version - the version; not null or empty

Returns:

the builder

See Also:

Swagger's BeanConfig

withDescription

public SwaggerBundle.FinalBuilder withDescription(java.lang.String description)

Description copied from interface: SwaggerBundle.FinalBuilder

Sets the description of the API.

Specified by:

withDescription in interface SwaggerBundle.FinalBuilder

Parameters:

description - the description; not null or empty

Returns:

the builder

See Also:

Swagger's BeanConfig

withTermsOfServiceUrl

public SwaggerBundle.FinalBuilder withTermsOfServiceUrl(java.lang.String termsOfServiceUrl)

Description copied from interface: SwaggerBundle.FinalBuilder

Sets the Terms of Service URL of the API.

Specified by:

withTermsOfServiceUrl in interface SwaggerBundle.FinalBuilder

Parameters:

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

Returns:

the builder

See Also:

Swagger's BeanConfig

withContact

public SwaggerBundle.FinalBuilder withContact(java.lang.String name)

Description copied from interface: SwaggerBundle.FinalBuilder

Sets the contact of the API.

Specified by:

withContact in interface SwaggerBundle.FinalBuilder

Parameters:

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

Returns:

the builder

See Also:

Swagger's BeanConfig

withContact

public SwaggerBundle.FinalBuilder withContact(java.lang.String name,
                                              java.lang.String email)

Description copied from interface: SwaggerBundle.FinalBuilder

Sets the contact of the API.

Specified by:

withContact in interface SwaggerBundle.FinalBuilder

Parameters:

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

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

Returns:

the builder

See Also:

Swagger's BeanConfig

withContact

public SwaggerBundle.FinalBuilder withContact(java.lang.String name,
                                              java.lang.String email,
                                              java.lang.String url)

Description copied from interface: SwaggerBundle.FinalBuilder

Sets the contact of the API.

Specified by:

withContact in interface SwaggerBundle.FinalBuilder

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

See Also:

Swagger's BeanConfig

withLicense

public SwaggerBundle.FinalBuilder withLicense(java.lang.String name)

Description copied from interface: SwaggerBundle.FinalBuilder

Sets the license of the API.

Specified by:

withLicense in interface SwaggerBundle.FinalBuilder

Parameters:

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

Returns:

the builder

See Also:

Swagger's BeanConfig

withLicense

public SwaggerBundle.FinalBuilder withLicense(java.lang.String name,
                                              java.lang.String url)

Description copied from interface: SwaggerBundle.FinalBuilder

Sets the license of the API.

Specified by:

withLicense in interface SwaggerBundle.FinalBuilder

Parameters:

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

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

Returns:

the builder

See Also:

Swagger's BeanConfig

addResourcePackage

public SwaggerBundle.FinalBuilder addResourcePackage(java.lang.String resourcePackage)

Description copied from interface: SwaggerBundle.InterimBuilder

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

Specified by:

addResourcePackage in interface SwaggerBundle.InterimBuilder

Parameters:

resourcePackage - the package to be scanned; not null

Returns:

the builder

See Also:

Swagger's BeanConfig

addResourcePackageClass

public SwaggerBundle.FinalBuilder addResourcePackageClass(java.lang.Class<?> resourcePackageClass)

Description copied from interface: SwaggerBundle.InterimBuilder

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

Specified by:

addResourcePackageClass in interface SwaggerBundle.InterimBuilder

Parameters:

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

Returns:

the builder

See Also:

Swagger's BeanConfig

build

public SwaggerBundle build()

Specified by:

build in interface SwaggerBundle.FinalBuilder