ar.com.jmfsg.documentation.model
Class Method

java.lang.Object
  ar.com.jmfsg.documentation.model.Method

public class Method
extends Object

Field Summary

String	description The description of the method that will appear on the main page
String	friendlyName Friendly name is used to generate the key of the documentation page.
String	group The group to which this service belongs
String	longDescription The description of the method that will appear on the method documentation page. If the longDescription is null, the description will be used in the method documentation page
RequestMethods	method Http method or methods of the service [GET|PUT|POST|DELETE|...] Supports a single String with the Http method or a Map containing the method as key and the requestMapping for that method as value, for example
int	order Order in which this method should be shown in the main documentation page.
Request	request All info regarding input for the service
String	requestMapping Method request mapping (relative to the documentation context)
List<Field>	response List of fields returned as a response item.
Boolean	responseIsList Wheter the expected response is a list or a single object.
List<Field>	responseSummary List of fields that represents a Summary of the response.
String	shortName Label to show in the index page instead of the requestMapping.
String	subGroup The subgroup to which this service belongs.
List<String>	tags List of Tag names that should be applied to this method

Constructor Summary

Method()

Method Summary

String	getDescription()
String	getFriendlyName()
String	getGroup()
String	getLongDescription()
RequestMethods	getMethod()
int	getOrder()
Request	getRequest()
String	getRequestMapping()
List<Field>	getResponse()
Boolean	getResponseIsList()
List<Field>	getResponseSummary()
String	getShortName()
String	getSubGroup()
List<String>	getTags()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

friendlyName

public String friendlyName

Friendly name is used to generate the key of the documentation page.
It should be descriptive but short and, if possible, all in lower case.

group

public String group

The group to which this service belongs

subGroup

public String subGroup

The subgroup to which this service belongs.

description

public String description

The description of the method that will appear on the main page

longDescription

public String longDescription

The description of the method that will appear on the method documentation page.
If the longDescription is null, the description will be used in the method documentation page

method

public RequestMethods method

Http method or methods of the service [GET|PUT|POST|DELETE|...]
Supports a single String with the Http method or a Map containing the method as key and the requestMapping for that method as value, for example

    {
       "GET" : "/service/object/{id}",
       "POST" : "/service/object"
    }
 

requestMapping

public String requestMapping

Method request mapping (relative to the documentation context)

order

public int order

Order in which this method should be shown in the main documentation page.

request

public Request request

All info regarding input for the service

responseIsList

public Boolean responseIsList

Wheter the expected response is a list or a single object.

response

public List<Field> response

List of fields returned as a response item.
The reponse itself may be a single item or a list of items.

responseSummary

public List<Field> responseSummary

List of fields that represents a Summary of the response.

tags

public List<String> tags

List of Tag names that should be applied to this method

shortName

public String shortName

Label to show in the index page instead of the requestMapping. It's an optional value.

Constructor Detail

Method

public Method()

Method Detail

getFriendlyName

public String getFriendlyName()

getGroup

public String getGroup()

getSubGroup

public String getSubGroup()

getDescription

public String getDescription()

getLongDescription

public String getLongDescription()

getMethod

public RequestMethods getMethod()

getRequestMapping

public String getRequestMapping()

getOrder

public int getOrder()

getRequest

public Request getRequest()

getResponse

public List<Field> getResponse()

getResponseSummary

public List<Field> getResponseSummary()

getTags

public List<String> getTags()

getShortName

public String getShortName()

getResponseIsList

public Boolean getResponseIsList()