Package io.swagger.annotations
Annotation Type ResponseHeader
-
@Target(METHOD) @Retention(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 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
String name
Header's name.- Default:
- ""
-
-
-
description
String description
Long description of the response header.- Default:
- ""
-
-
-
response
Class<?> response
Header's data type.- Default:
- java.lang.Void.class
-
-
-
responseContainer
String responseContainer
Declares a container wrapping the response header.Valid values are "List" or "Set". Any other value will be ignored.
- Default:
- ""
-
-