io.swagger.annotations

Annotation Type ResponseHeader

@Target(value=METHOD)
@Retention(value=RUNTIME)
public @interface ResponseHeader

Represents a header that can be provided as part of the response.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	description Long description of the response header.
String	name Header's name.
Class<?>	response Header's data type.
String	responseContainer Declares a container wrapping the response header.

Element Detail

name

public abstract String name

Header's name.

Default:

""

description

public abstract String description

Long description of the response header.

Default:

""

response

public abstract Class<?> response

Header's data type.

Default:

java.lang.Void.class

responseContainer

public abstract String responseContainer

Declares a container wrapping the response header.

Valid values are "List" or "Set". Any other value will be ignored.

Default:

""