io.swagger.v3.oas.annotations.responses

Annotation Type ApiResponse

@Target(value=METHOD)
 @Retention(value=RUNTIME)
 @Inherited
 @Repeatable(value=ApiResponses.class)
public @interface ApiResponse

The annotation may be used at method level or as field of Operation to define one or more responses of the Operation.

swagger-jaxrs2 reader engine considers this annotation along with method return type and context as input to resolve the OpenAPI Operation responses.

See Also:

Response (OpenAPI specification), Operation

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Content[]	content An array containing descriptions of potential response payloads, for different media types.
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.
String	responseCode The HTTP response code, or 'default', for the supplied response.

Element Detail

description

public abstract String description

A short description of the response.

Returns:

description of the response

Default:

""

responseCode

public abstract String responseCode

The HTTP response code, or 'default', for the supplied response. May only have 1 default entry.

Returns:

response code

Default:

"default"

headers

public abstract Header[] headers

An array of response headers. Allows additional information to be included with response.

Returns:

array of headers

Default:

{}

links

public abstract Link[] links

An array of operation links that can be followed from the response.

Returns:

array of links

Default:

{}

content

public abstract Content[] content

An array containing descriptions of potential response payloads, for different media types.

Returns:

array of content

Default:

{}