Package io.swagger.v3.oas.annotations.info

Annotation Type Info

@Target(ANNOTATION_TYPE)
@Retention(RUNTIME)
@Inherited
public @interface Info

The annotation may be used in OpenAPIDefinition.info() to populate the Info section of the OpenAPI document.

See Also:

Info (OpenAPI specification), Info (OpenAPI specification), OpenAPIDefinition

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
Contact	contact	The contact information for the exposed API.
String	description	A short description of the application.
Extension[]	extensions	The list of optional extensions
License	license	The license information for the exposed API.
String	summary	A short API summary.
String	termsOfService	A URL to the Terms of Service for the API.
String	title	The title of the application.
String	version	The version of the API definition.

Element Detail

title

String title

The title of the application.

Returns:

the application's title

Default:

""

description

String description

A short description of the application. CommonMark syntax can be used for rich text representation.

Returns:

the application's description

Default:

""

termsOfService

String termsOfService

A URL to the Terms of Service for the API. Must be in the format of a URL.

Returns:

the application's terms of service

Default:

""

contact

Contact contact

The contact information for the exposed API.

Returns:

a contact for the application

Default:

@io.swagger.v3.oas.annotations.info.Contact

license

License license

The license information for the exposed API.

Returns:

the license of the application

Default:

@io.swagger.v3.oas.annotations.info.License

version

String version

The version of the API definition.

Returns:

the application's version

Default:

""

extensions

Extension[] extensions

The list of optional extensions

Returns:

an optional array of extensions

Default:

{}

summary

String summary

A short API summary.

Returns:

API summary

Since:

2.2.12 / OpenAPI 3.1

Default:

""