springfox.documentation.builders

Class ApiInfoBuilder

java.lang.Object

springfox.documentation.builders.ApiInfoBuilder

public class ApiInfoBuilder
extends java.lang.Object

Builds the api information

Constructor Summary

Constructors

Constructor and Description
ApiInfoBuilder()

Method Summary

Methods

Modifier and Type	Method and Description
ApiInfo	build()
ApiInfoBuilder	contact(Contact contact) Updates contact information for the person responsible for this API
ApiInfoBuilder	contact(java.lang.String contact) Deprecated. @since 2.4.0. Use the overload that takes in a contact instead
ApiInfoBuilder	description(java.lang.String description) Updates the api description
ApiInfoBuilder	extensions(java.util.List<VendorExtension> extensions) Adds extensions for this API
ApiInfoBuilder	license(java.lang.String license) Updates license information for this API
ApiInfoBuilder	licenseUrl(java.lang.String licenseUrl) Updates the license Url for this API
ApiInfoBuilder	termsOfServiceUrl(java.lang.String termsOfServiceUrl) Updates the terms of service url
ApiInfoBuilder	title(java.lang.String title) Updates the api title
ApiInfoBuilder	version(java.lang.String version) Updates the api version

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiInfoBuilder

public ApiInfoBuilder()

Method Detail

title

public ApiInfoBuilder title(java.lang.String title)

Updates the api title

Parameters:

title - - title for the API

Returns:

this

description

public ApiInfoBuilder description(java.lang.String description)

Updates the api description

Parameters:

description - - api description

Returns:

this

termsOfServiceUrl

public ApiInfoBuilder termsOfServiceUrl(java.lang.String termsOfServiceUrl)

Updates the terms of service url

Parameters:

termsOfServiceUrl - - url to the terms of service

Returns:

this

version

public ApiInfoBuilder version(java.lang.String version)

Updates the api version

Parameters:

version - - of the API

Returns:

this

contact

@Deprecated
public ApiInfoBuilder contact(java.lang.String contact)

Deprecated. @since 2.4.0. Use the overload that takes in a contact instead

Updates contact information for the person responsible for this API

Parameters:

contact - - contact information

Returns:

this

contact

public ApiInfoBuilder contact(Contact contact)

Updates contact information for the person responsible for this API

Parameters:

contact - - contact information

Returns:

this

license

public ApiInfoBuilder license(java.lang.String license)

Updates license information for this API

Parameters:

license -

Returns:

this

licenseUrl

public ApiInfoBuilder licenseUrl(java.lang.String licenseUrl)

Updates the license Url for this API

Parameters:

licenseUrl - - license Url

Returns:

this

extensions

public ApiInfoBuilder extensions(java.util.List<VendorExtension> extensions)

Adds extensions for this API

Parameters:

extensions - - extensions

Returns:

this

build

public ApiInfo build()