public class MethodDefinition extends RestDocObject
additionalFields| Constructor and Description |
|---|
MethodDefinition() |
| Modifier and Type | Method and Description |
|---|---|
MethodDefinition |
accept(String _type,
String _schema) |
MethodDefinition |
description(String _description) |
MethodDefinition |
example(ExampleRequest _exampleRequest) |
Collection<Representation> |
getAccepts() |
String |
getDescription() |
Collection<ExampleRequest> |
getExamples() |
Map<String,HeaderDefinition> |
getHeaders() |
ResponseDefinition |
getResponse() |
Map<String,String> |
getStatusCodes() |
MethodDefinition |
header(String _name,
String _description,
boolean _required) |
MethodDefinition |
response(ResponseDefinition _response) |
void |
setDescription(String description) |
void |
setResponse(ResponseDefinition response) |
MethodDefinition |
statusCode(String _code,
String _description) |
getAdditionalBoolean, getAdditionalField, getAdditionalFields, getAdditionalNumber, getAdditionalString, setAdditionalFieldpublic String getDescription()
public void setDescription(String description)
description - the description to setpublic ResponseDefinition getResponse()
public void setResponse(ResponseDefinition response)
response - the response to setpublic Collection<Representation> getAccepts()
public Map<String,HeaderDefinition> getHeaders()
public Collection<ExampleRequest> getExamples()
public MethodDefinition description(String _description)
_description - public MethodDefinition statusCode(String _code, String _description)
_code - _description - public MethodDefinition accept(String _type, String _schema)
_type - _schema - public MethodDefinition header(String _name, String _description, boolean _required)
_name - _description - _required - public MethodDefinition response(ResponseDefinition _response)
_response - public MethodDefinition example(ExampleRequest _exampleRequest)
_exampleRequest - Copyright © 2012-2014 RestDoc org. All Rights Reserved.