ApiKeyAuthDefinition (swagger-annotations 1.6.16 API)

```
public @interface ApiKeyAuthDefinition
```
Annotation used to construct ApiKey Auth security definition.

Required Element Summary

Required Elements
Modifier and Type	Required Element	Description
`ApiKeyAuthDefinition.ApiKeyLocation`	`in`	The location of the API key.
`String`	`key`	Key used to refer to this security definition
`String`	`name`	The name of the header or query parameter to be used.

Optional Element Summary

Optional Elements
Modifier and Type Optional Element Description

String description
A short description for security scheme.

- Element Detail
  - key
```
String key
```
    Key used to refer to this security definition
    
    Returns:
    
    key used to refer to this security definition
- - in
```
ApiKeyAuthDefinition.ApiKeyLocation in
```
    The location of the API key. Valid values are "query" or "header"
    
    Returns:
- - name
```
String name
```
    The name of the header or query parameter to be used.
    
    Returns:
    
    the name of the header or query parameter to be used.
- - description
```
String description
```
    A short description for security scheme.
    
    Returns:
    
    a short description for security scheme.
    
    Default:
    
    ""