io.swagger.v3.oas.annotations

Annotation Type OpenAPIDefinition

@Target(value={TYPE,PACKAGE,ANNOTATION_TYPE})
 @Retention(value=RUNTIME)
 @Inherited
public @interface OpenAPIDefinition

The annotation that may be used to populate OpenAPI Object fields info, tags, servers, security and externalDocs If more than one class is annotated with OpenAPIDefinition, with the same fields defined, behaviour is inconsistent.

See Also:

OpenAPI (OpenAPI specification)

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Extension[]	extensions The list of optional extensions
ExternalDocumentation	externalDocs Any additional external documentation for the API
Info	info Provides metadata about the API.
SecurityRequirement[]	security A declaration of which security mechanisms can be used across the API.
Server[]	servers An array of Server Objects, which provide connectivity information to a target server.
Tag[]	tags A list of tags used by the specification with additional metadata.

Element Detail

info

public abstract Info info

Provides metadata about the API. The metadata MAY be used by tooling as required.

Returns:

the metadata about this API

Default:

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

tags

public abstract Tag[] tags

A list of tags used by the specification with additional metadata. The order of the tags can be used to reflect on their order by the parsing tools.

Returns:

the tags used by the specification with any additional metadata

Default:

{}

servers

public abstract Server[] servers

An array of Server Objects, which provide connectivity information to a target server. If the servers property is not provided, or is an empty array, the default value would be a Server Object with a url value of /.

Returns:

the servers of this API

Default:

{}

security

public abstract SecurityRequirement[] security

A declaration of which security mechanisms can be used across the API.

Returns:

the array of servers used for this API

Default:

{}

externalDocs

public abstract ExternalDocumentation externalDocs

Any additional external documentation for the API

Returns:

the external documentation for this API.

Default:

@io.swagger.v3.oas.annotations.ExternalDocumentation

extensions

public abstract Extension[] extensions

The list of optional extensions

Returns:

an optional array of extensions

Default:

{}