public abstract class RequestDocumentation extends Object
| Modifier and Type | Method and Description |
|---|---|
static ParameterDescriptor |
parameterWithName(String name)
Creates a
ParameterDescriptor that describes a request or path parameter
with the given name. |
static Snippet |
pathParameters(Map<String,Object> attributes,
ParameterDescriptor... descriptors)
Returns a snippet that will document the path parameters from the API call's
request.
|
static Snippet |
pathParameters(ParameterDescriptor... descriptors)
Returns a snippet that will document the path parameters from the API call's
request.
|
static Snippet |
requestParameters(Map<String,Object> attributes,
ParameterDescriptor... descriptors)
Returns a snippet that will document the request parameters from the API call's
request.
|
static Snippet |
requestParameters(ParameterDescriptor... descriptors)
Returns a snippet that will document the request parameters from the API call's
request.
|
public static ParameterDescriptor parameterWithName(String name)
ParameterDescriptor that describes a request or path parameter
with the given name.name - The name of the parameterParameterDescriptor ready for further configurationpublic static Snippet pathParameters(ParameterDescriptor... descriptors)
descriptors - The descriptions of the parameters in the request's pathPathVariablepublic static Snippet pathParameters(Map<String,Object> attributes, ParameterDescriptor... descriptors)
attributes will be available during snippet rendering.attributes - Attributes made available during rendering of the path parameters
snippetdescriptors - The descriptions of the parameters in the request's pathPathVariablepublic static Snippet requestParameters(ParameterDescriptor... descriptors)
descriptors - The descriptions of the request's parametersRequestParam,
ServletRequest.getParameterMap()public static Snippet requestParameters(Map<String,Object> attributes, ParameterDescriptor... descriptors)
attributes will be available during snippet rendering.attributes - Attributes made available during rendering of the request
parameters snippetdescriptors - The descriptions of the request's parametersRequestParam,
ServletRequest.getParameterMap()