Annotation Interface OpenApi.Info

Enclosing class:

OpenApi

@Target(TYPE)
@Retention(CLASS)
@Documented
public static @interface OpenApi.Info

OpenAPI Info Object metadata.

Use only on @OpenApi.Document metadata types.

Required Element Summary

Required Elements

Modifier and Type	Required Element	Description
String	title	API title.
String	version	API version.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String	description	API description.
String	summary	API summary.
String	termsOfService	API terms of service URL.

Element Details

title

String title

API title.

Returns:

title

version

String version

API version.

Returns:

version

description

String description

API description.

Returns:

description

Default:

""

summary

String summary

API summary.

Rendered only for OpenAPI 3.1 and later output.

Returns:

summary

Default:

""

termsOfService

String termsOfService

API terms of service URL.

Returns:

terms of service URL

Default:

""