org.jsondoc.core.annotation

Annotation Type ApiMethod

@Documented
 @Target(value=METHOD)
 @Retention(value=RUNTIME)
public @interface ApiMethod

This annotation is to be used on your exposed methods.

Author:

Fabio Maffioletti

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String[]	consumes An array of strings representing media types consumed by the method, like application/json, application/xml, ...
String	description A description of what the method does
String	id A custom identifier to be used inside JSONDoc.
String[]	path The relative path for this method (ex.
String[]	produces An array of strings representing media types produced by the method, like application/json, application/xml, ...
String	responsestatuscode Response status code that this method will return to the caller.
ApiStage	stage Indicates the stage of development or release
String	summary A summary of what the method does.
ApiVerb[]	verb The request verb for this method.
ApiVisibility	visibility Indicates the visibility of the method

Element Detail

id

public abstract String id

A custom identifier to be used inside JSONDoc. This string has to be unique inside the JSONDoc documentation. It's responsibility of the documentation writer to guarantee this uniqueness

Returns:

Default:

""

path

public abstract String[] path

The relative path for this method (ex. /country/get/{name})

Returns:

Default:

{}

summary

public abstract String summary

A summary of what the method does. It's like a short description.

Returns:

Default:

""

description

public abstract String description

A description of what the method does

Returns:

Default:

""

verb

public abstract ApiVerb[] verb

The request verb for this method. Defaults to "GET"

Returns:

See Also:

ApiVerb

Default:

org.jsondoc.core.pojo.ApiVerb.GET

produces

public abstract String[] produces

An array of strings representing media types produced by the method, like application/json, application/xml, ...

Returns:

Default:

{}

consumes

public abstract String[] consumes

An array of strings representing media types consumed by the method, like application/json, application/xml, ...

Returns:

Default:

{}

responsestatuscode

public abstract String responsestatuscode

Response status code that this method will return to the caller. Defaults to 200

Default:

"200 - OK"

visibility

public abstract ApiVisibility visibility

Indicates the visibility of the method

Returns:

Default:

org.jsondoc.core.pojo.ApiVisibility.UNDEFINED

stage

public abstract ApiStage stage

Indicates the stage of development or release

Returns:

Default:

org.jsondoc.core.pojo.ApiStage.UNDEFINED