Package org.apache.juneau.http

Annotation Interface Tag

@Documented
@Retention(RUNTIME)
public @interface Tag

Swagger tag annotation.

Allows adding meta data to a single tag that is used by the Swagger Operation Object. It is not mandatory to have a Tag Object per tag used there.

Used to populate the auto-generated Swagger documentation and UI for server-side @Rest-annotated classes.

Example:

// A response object thats a hex-encoded string @Rest( swagger=@Swagger{ tags={ @Tag( name="utility", description="Utility methods" ) } } )

See Also:

• juneau-bean-swagger-v2
• Swagger Tag Object

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String[]	description	description field of the Swagger Tag Object.
ExternalDocs	externalDocs	externalDocs field of the Swagger Tag Object.
String	name	name field of the Swagger Tag Object.

Element Details

description

String[] description

description field of the Swagger Tag Object.

Notes:

• The format is a juneau-bean-swagger-v2 object.
  Multiple lines are concatenated with newlines.
• Supports REST Server SVL Variables (e.g. "$L{my.localized.variable}") for the swagger generator.

Returns:

The annotation value.

Default:

{}

externalDocs

ExternalDocs externalDocs

externalDocs field of the Swagger Tag Object.

Notes:

• The format is a juneau-bean-swagger-v2 object.
  Multiple lines are concatenated with newlines.

Returns:

The annotation value.

Default:

@org.apache.juneau.commons.ExternalDocs

name

String name

name field of the Swagger Tag Object.

Notes:

• The format is plain text.

Returns:

The annotation value.

Default:

""