Annotation Interface 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
Modifier and TypeOptional ElementDescriptionContent[]
An array containing descriptions of potential response payloads for different media types.A short description of the response.Header[]
An array of response headers.Link[]
An array of operation links that can be followed from the response.The unique name to identify this response.Reference value to a Response object.The HTTP response code, or 'default', for the supplied response.
-
Element Details
-
description
String descriptionA short description of the response. It is a REQUIRED property unless this is only a reference to a response instance.- Returns:
- description of the response.
- Default:
- ""
-
responseCode
String responseCodeThe HTTP response code, or 'default', for the supplied response. May only have 1 default entry.- Returns:
- HTTP response code for this response instance or default
- Default:
- "default"
-
headers
Header[] headersAn 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[] linksAn array of operation links that can be followed from the response.- Returns:
- array of operation links for this response instance
- Default:
- {}
-
content
Content[] contentAn array containing descriptions of potential response payloads for different media types.- Returns:
- content of this response instance
- Default:
- {}
-
name
String nameThe 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
String refReference 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:
- ""
-