com.wordnik.swagger.annotations

Annotation Type Tag

@Target(value={PARAMETER,METHOD,FIELD})
@Retention(value=RUNTIME)
public @interface Tag

Represents a single tag in an Api. A Tag is an organizing object for the to the API.

Since:

1.5.2

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	value Name of the tag.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	description A short description for the tag.
ExternalDocs	externalDocs Additional external documentation.

Element Detail

value

public abstract String value

Name of the tag.

description

public abstract String description

A short description for the tag. GFM syntax can be used for rich text representation.

Default:

""

externalDocs

public abstract ExternalDocs externalDocs

Additional external documentation.

Default:

@com.wordnik.swagger.annotations.ExternalDocs(value="", url="")