Package springfox.documentation.service

Class ApiInfo

java.lang.Object

springfox.documentation.service.ApiInfo

public class ApiInfo
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
static ApiInfo	DEFAULT
static Contact	DEFAULT_CONTACT

Constructor Summary

Constructors

Constructor	Description
ApiInfo(java.lang.String title, java.lang.String description, java.lang.String version, java.lang.String termsOfServiceUrl, java.lang.String contactName, java.lang.String license, java.lang.String licenseUrl)	Deprecated.
ApiInfo(java.lang.String title, java.lang.String description, java.lang.String version, java.lang.String termsOfServiceUrl, Contact contact, java.lang.String license, java.lang.String licenseUrl, java.util.Collection<VendorExtension> vendorExtensions)	Default contstructor

Method Summary

Modifier and Type	Method	Description
Contact	getContact()
java.lang.String	getDescription()
java.lang.String	getLicense()
java.lang.String	getLicenseUrl()
java.lang.String	getTermsOfServiceUrl()
java.lang.String	getTitle()
java.util.List<VendorExtension>	getVendorExtensions()
java.lang.String	getVersion()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CONTACT

public static final Contact DEFAULT_CONTACT

DEFAULT

public static final ApiInfo DEFAULT

Constructor Detail

ApiInfo

@Deprecated
public ApiInfo(java.lang.String title,
               java.lang.String description,
               java.lang.String version,
               java.lang.String termsOfServiceUrl,
               java.lang.String contactName,
               java.lang.String license,
               java.lang.String licenseUrl)

Deprecated.

Deprecated in favor of richer contact object

Parameters:

title - title

description - description

version - version

termsOfServiceUrl - terms of service

contactName - contact name

license - licence text

licenseUrl - license url

Since:

2.4.0

ApiInfo

public ApiInfo(java.lang.String title,
               java.lang.String description,
               java.lang.String version,
               java.lang.String termsOfServiceUrl,
               Contact contact,
               java.lang.String license,
               java.lang.String licenseUrl,
               java.util.Collection<VendorExtension> vendorExtensions)

Default contstructor

Parameters:

title - title

description - description

version - version

termsOfServiceUrl - termsOfServiceUrl

contact - contact

license - license

licenseUrl - license url

vendorExtensions - vendor extensions

Method Detail

getTitle

public java.lang.String getTitle()

getDescription

public java.lang.String getDescription()

getTermsOfServiceUrl

public java.lang.String getTermsOfServiceUrl()

getContact

public Contact getContact()

getLicense

public java.lang.String getLicense()

getLicenseUrl

public java.lang.String getLicenseUrl()

getVersion

public java.lang.String getVersion()

getVendorExtensions

public java.util.List<VendorExtension> getVendorExtensions()