io.swagger.annotations

Annotation Type ApiKeyAuthDefinition

public @interface ApiKeyAuthDefinition

Annotation used to construct ApiKey Auth security definition.

Required Element Summary

Required Elements

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

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String	description A short description for security scheme.

Element Detail

key

public abstract java.lang.String key

Key used to refer to this security definition

Returns:

key used to refer to this security definition

in

public abstract ApiKeyAuthDefinition.ApiKeyLocation in

The location of the API key. Valid values are "query" or "header"

Returns:

name

public abstract java.lang.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

public abstract java.lang.String description

A short description for security scheme.

Returns:

a short description for security scheme.

Default:

""