io.micronaut.openapi.annotation

Annotation Type OpenAPIInclude

@Repeatable(value=OpenAPIIncludes.class)
 @Retention(value=RUNTIME)
 @Documented
 @Target(value={TYPE,ANNOTATION_TYPE})
public @interface OpenAPIInclude

The annotation can be used to include additional io.micronaut.http.annotation.Controller or io.micronaut.management.endpoint.annotation.Endpoint classes to be processed for OpenAPI definition. This is useful in cases where you cannot alter the source code and wish to generate Open API for already compiled classes.

Author:

Denis Stepanov

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.Class<?>[]	classes
java.lang.String[]	classNames
io.swagger.v3.oas.annotations.security.SecurityRequirement[]	security A declaration of which security mechanisms can be used across the API.
io.swagger.v3.oas.annotations.tags.Tag[]	tags A list of tags used by the specification with additional metadata.
java.lang.String	uri
java.lang.Class<?>[]	value

Element Detail

value

public abstract java.lang.Class<?>[] value

Returns:

The classes to generate Open API for.

Default:

{}

classes

@AliasFor(member="value")
public abstract java.lang.Class<?>[] classes

Returns:

The classes to generate Open API for.

Default:

{}

classNames

@AliasFor(member="value")
public abstract java.lang.String[] classNames

Returns:

The classes to generate Open API for.

Default:

{}

uri

public abstract java.lang.String uri

Returns:

Custom URI for controller

Since:

4.4.0

Default:

""

tags

public abstract io.swagger.v3.oas.annotations.tags.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:

{}

security

public abstract io.swagger.v3.oas.annotations.security.SecurityRequirement[] security

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

Returns:

the array of servers used for this API

Default:

{}