Annotation Type APIResponse
-
@Target(METHOD) @Retention(RUNTIME) @Inherited @Repeatable(APIResponses.class) public @interface APIResponse
The ApiResponse annotation corresponds to the OpenAPI Response model object which describes a single response from an API Operation, including design-time, static links to operations based on the response.When this annotation is applied to a method the response is added to the responses defined in the corresponding OpenAPI operation. If the operation already has a response with the specified responseCode the annotation on the method is ignored.
@ApiResponse(responseCode="200", description="Calculate load size", content= [ @Content(mediaType="application/json", Schema=@Schema(type="integer")) ] ) @GET public getLuggageWeight(Flight id) { return getBagWeight(id) + getCargoWeight(id); }
- See Also:
- "https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#responseObject"
-
-
Optional Element Summary
Optional Elements Modifier and Type Optional Element Description Content[]
content
An array containing descriptions of potential response payloads for different media types.java.lang.String
description
A short description of the response.Header[]
headers
An array of response headers.Link[]
links
An array of operation links that can be followed from the response.java.lang.String
name
The unique name to identify this response.java.lang.String
ref
Reference value to a Response object.java.lang.String
responseCode
The HTTP response code, or 'default', for the supplied response.
-
-
-
-
headers
Header[] headers
An array of response headers. Allows additional information to be included with response.RFC7230 states header names are case insensitive. If a response header is defined with the name "Content-Type", it SHALL be ignored.
- Returns:
- array of headers for this response instance
- Default:
- {}
-
-
-
links
Link[] links
An array of operation links that can be followed from the response.- Returns:
- array of operation links for this response instance
- Default:
- {}
-
-
-
content
Content[] content
An array containing descriptions of potential response payloads for different media types.- Returns:
- content of this response instance
- Default:
- {}
-
-
-
name
java.lang.String name
The unique name to identify this response. Only REQUIRED when the response is defined withinComponents
. The name will be used as the key to add this response to the 'responses' map for reuse.- Returns:
- this response's name
- Default:
- ""
-
-
-
ref
java.lang.String ref
Reference value to a Response object.This property provides a reference to an object defined elsewhere. This property and all other properties are mutually exclusive. If other properties are defined in addition to the ref property then the result is undefined.
- Returns:
- reference to a response
- Default:
- ""
-
-