io.muserver.rest

Annotation Type ApiResponse

@Target(value={METHOD,TYPE})
 @Retention(value=RUNTIME)
 @Repeatable(value=ApiResponses.class)
public @interface ApiResponse

Describes a response code and description for an API method, for documentation purposes.

Multiple annotations can be added to cover multiple response types.

See Also:

ApiResponses

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	code The HTTP status code of the response.
String	message A short description of the response.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String[]	contentType The content type for this code, if different from the default
String	example An example return value
Class<?>	response The type of the response body.
ResponseHeader[]	responseHeaders A list of possible headers provided alongside the response.

Element Detail

code

public abstract String code

The HTTP status code of the response. This is a String to allow values such as "2XX" to cover all 200-299 codes.

Returns:

The code

message

public abstract String message

A short description of the response. CommonMark syntax MAY be used for rich text representation.

Returns:

The description

responseHeaders

public abstract ResponseHeader[] responseHeaders

A list of possible headers provided alongside the response.

Returns:

a list of response headers.

Default:

{}

response

public abstract Class<?> response

The type of the response body.

Returns:

The type

Default:

java.lang.Void.class

contentType

public abstract String[] contentType

The content type for this code, if different from the default

Returns:

A content type such as text/plain

Default:

{}

example

public abstract String example

An example return value

Returns:

An example value

Default:

""