com.wordnik.swagger.annotations

Annotation Type ApiResponse

@Target(value=METHOD)
@Retention(value=RUNTIME)
public @interface ApiResponse

An ApiResponse represents a type of response from a server. This can be used to describe both success codes as well as errors. If your Api has different response classes, you can describe them here by associating a response class with a response code. Note, Swagger does not allow multiple response types for a single response code.

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
int	code Response code to describe
String	message Human-readable message to accompany the response

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Class<?>	response Optional response class to describe the payload of the message
ResponseHeader[]	responseHeaders

Element Detail

code

public abstract int code

Response code to describe

message

public abstract String message

Human-readable message to accompany the response

response

public abstract Class<?> response

Optional response class to describe the payload of the message

Default:

java.lang.Void.class

responseHeaders

public abstract ResponseHeader[] responseHeaders

Default:

@com.wordnik.swagger.annotations.ResponseHeader(name="", response=java.lang.Void.class)