com.wordnik.swagger.annotations

Annotation Type ApiOperation

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

Describes an operation or typically a HTTP method against a specific path. Operations with equivalent paths are grouped in an array in the Api Declaration. See https://github.com/wordnik/swagger-core/wiki/API-Declaration

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	value Brief description of the operation

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
Authorization[]	authorizations authorizations required by this Api
String	consumes media type consumed by this Api
boolean	hidden Allows an operation to be marked as hidden
String	httpMethod the HTTP method, i.e GET, PUT, POST, DELETE, PATCH, OPTIONS
String	nickname the nickname for the operation, to override what is detected by the annotation scanner
String	notes long description of the operation
int	position allow explicit ordering of operations inside the Api Declaration
String	produces content type produced by this Api
String	protocols protocols that this Api requires (i.e.
Class<?>	response default response class from the operation
String	responseContainer if the response class is within a container, specify it here
ResponseHeader[]	responseHeaders
String[]	tags A list of tags for API documentation control.

Element Detail

value

public abstract String value

Brief description of the operation

notes

public abstract String notes

long description of the operation

Default:

""

tags

public abstract String[] tags

A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.

Since:

1.5.2

Default:

""

response

public abstract Class<?> response

default response class from the operation

Default:

java.lang.Void.class

responseContainer

public abstract String responseContainer

if the response class is within a container, specify it here

Default:

""

httpMethod

public abstract String httpMethod

the HTTP method, i.e GET, PUT, POST, DELETE, PATCH, OPTIONS

Default:

""

position

public abstract int position

allow explicit ordering of operations inside the Api Declaration

Default:

0

nickname

public abstract String nickname

the nickname for the operation, to override what is detected by the annotation scanner

Default:

""

produces

public abstract String produces

content type produced by this Api

Default:

""

consumes

public abstract String consumes

media type consumed by this Api

Default:

""

protocols

public abstract String protocols

protocols that this Api requires (i.e. https)

Default:

""

authorizations

public abstract Authorization[] authorizations

authorizations required by this Api

Default:

@com.wordnik.swagger.annotations.Authorization(value="", type="")

hidden

public abstract boolean hidden

Allows an operation to be marked as hidden

Default:

false

responseHeaders

public abstract ResponseHeader[] responseHeaders

Default:

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