io.swagger.annotations

Annotation Type Info

@Target(value=ANNOTATION_TYPE)
 @Retention(value=RUNTIME)
public @interface Info

High-level metadata for a Swagger definition - see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#infoObject

Since:

1.5.0

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	title The title of the API.
String	version The version of your API.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Contact	contact Optional contact information for this API.
String	description An optional description of the API.
Extension[]	extensions Optional list of extensions for this API.
License	license Optional license information for this API.
String	termsOfService An optional terms of service for this API.

Element Detail

title

public abstract String title

The title of the API.

Returns:

the title of the API

version

public abstract String version

The version of your API.

Returns:

the version of your API

description

public abstract String description

An optional description of the API.

Returns:

an optional description of the API

Default:

""

termsOfService

public abstract String termsOfService

An optional terms of service for this API.

Returns:

an optional terms of service for this API

Default:

""

contact

public abstract Contact contact

Optional contact information for this API.

Returns:

optional contact information for this API

Default:

@io.swagger.annotations.Contact(name="")

license

public abstract License license

Optional license information for this API.

Returns:

optional license information for this API

Default:

@io.swagger.annotations.License(name="")

extensions

public abstract Extension[] extensions

Optional list of extensions for this API.

Returns:

optional list of extensions for this API

See Also:

Extension

Default:

@io.swagger.annotations.Extension(properties=@io.swagger.annotations.ExtensionProperty(name="", value=""))