springfox.documentation.builders

类 ApiInfoBuilder

java.lang.Object

springfox.documentation.builders.ApiInfoBuilder

public class ApiInfoBuilder
extends Object

Builds the api information

构造器概要

构造器

构造器和说明
ApiInfoBuilder()

方法概要

限定符和类型	方法和说明
ApiInfo	build()
ApiInfoBuilder	contact(Contact contact) Updates contact information for the person responsible for this API
ApiInfoBuilder	contact(String contact) 已过时。 @since 2.4.0. Use the overload that takes in a contact instead
ApiInfoBuilder	description(String description) Updates the api description
ApiInfoBuilder	extensions(List<VendorExtension> extensions) Adds extensions for this API
ApiInfoBuilder	license(String license) Updates license information for this API
ApiInfoBuilder	licenseUrl(String licenseUrl) Updates the license Url for this API
ApiInfoBuilder	termsOfServiceUrl(String termsOfServiceUrl) Updates the terms of service url
ApiInfoBuilder	title(String title) Updates the api title
ApiInfoBuilder	version(String version) Updates the api version

从类继承的方法 java.lang.Object

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

构造器详细资料

ApiInfoBuilder

public ApiInfoBuilder()

方法详细资料

title

public ApiInfoBuilder title(String title)

Updates the api title

参数:

title - - title for the API

返回:

this

description

public ApiInfoBuilder description(String description)

Updates the api description

参数:

description - - api description

返回:

this

termsOfServiceUrl

public ApiInfoBuilder termsOfServiceUrl(String termsOfServiceUrl)

Updates the terms of service url

参数:

termsOfServiceUrl - - url to the terms of service

返回:

this

version

public ApiInfoBuilder version(String version)

Updates the api version

参数:

version - - of the API

返回:

this

contact

@Deprecated
public ApiInfoBuilder contact(String contact)

已过时。 @since 2.4.0. Use the overload that takes in a contact instead

Updates contact information for the person responsible for this API

参数:

contact - - contact information

返回:

this

contact

public ApiInfoBuilder contact(Contact contact)

Updates contact information for the person responsible for this API

参数:

contact - - contact information

返回:

this

license

public ApiInfoBuilder license(String license)

Updates license information for this API

参数:

license - licence string

返回:

this

licenseUrl

public ApiInfoBuilder licenseUrl(String licenseUrl)

Updates the license Url for this API

参数:

licenseUrl - - license Url

返回:

this

extensions

public ApiInfoBuilder extensions(List<VendorExtension> extensions)

Adds extensions for this API

参数:

extensions - - extensions

返回:

this

build

public ApiInfo build()