Package io.swagger.annotations

Enum Summary

Enum	Description
ApiKeyAuthDefinition.ApiKeyLocation
OAuth2Definition.Flow
SwaggerDefinition.Scheme	Enumeration with valid schemes

Annotation Types Summary

Annotation Type	Description
Api	Marks a class as a Swagger resource.
ApiImplicitParam	Represents a single parameter in an API Operation.
ApiImplicitParams	A wrapper to allow a list of multiple ApiImplicitParam objects.
ApiKeyAuthDefinition	Annotation used to construct ApiKey Auth security definition.
ApiModel	Provides additional information about Swagger models.
ApiModelProperty	Adds and manipulates data of a model property.
ApiOperation	Describes an operation or typically a HTTP method against a specific path.
ApiParam	Adds additional meta-data for operation parameters.
ApiResponse	Describes a possible response of an operation.
ApiResponses	A wrapper to allow a list of multiple ApiResponse objects.
Authorization	Defines an authorization scheme to be used on a resource or an operation.
AuthorizationScope	Describes an OAuth2 authorization scope.
BasicAuthDefinition	Annotation used to construct Basic Auth security definition.
Contact	Contact metadata available within the info section of a Swagger definition - see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#contactObject
Example	An optionally named list of example properties.
ExampleProperty	A mediaType/value property within a Swagger example
Extension	An optionally named list of extension properties.
ExtensionProperty	A name/value property within a Swagger extension
ExternalDocs	Represents an external documentation description.
Info	High-level metadata for a Swagger definition - see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#infoObject
License	License metadata available within the info section of a Swagger definition, see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#licenseObject
OAuth2Definition	Annotation used to construct OAuth security definition.
ResponseHeader	Represents a header that can be provided as part of the response.
Scope	The available scopes for an OAuth2 security scheme
SecurityDefinition	An aggregation of all security definitions.
SwaggerDefinition	Annotation that configures definition level metadata.
Tag	A definition level Tag object see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#tag-object