org.springframework.restdocs.request

Class RequestDocumentation

java.lang.Object

org.springframework.restdocs.request.RequestDocumentation

public abstract class RequestDocumentation
extends Object

Static factory methods for documenting aspects of a request sent to a RESTful API.

Author:

Andy Wilkinson

Method Summary

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 operation's request.
static Snippet	pathParameters(ParameterDescriptor... descriptors) Returns a Snippet that will document the path parameters from the API operation's request.
static Snippet	requestParameters(Map<String,Object> attributes, ParameterDescriptor... descriptors) Returns a Snippet that will document the parameters from the API operation's request.
static Snippet	requestParameters(ParameterDescriptor... descriptors) Returns a Snippet that will document the parameters from the API operation's request.

Methods inherited from class java.lang.Object

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

Method Detail

parameterWithName

public static ParameterDescriptor parameterWithName(String name)

Creates a ParameterDescriptor that describes a request or path parameter with the given name.

Parameters:

name - The name of the parameter

Returns:

a ParameterDescriptor ready for further configuration

pathParameters

public static Snippet pathParameters(ParameterDescriptor... descriptors)

Returns a Snippet that will document the path parameters from the API operation's request. The parameters will be documented using the given descriptors.

If a parameter is present in the request path, but is not documented by one of the descriptors, a failure will occur when the snippet is invoked. Similarly, if a parameter is documented, is not marked as optional, and is not present in the request path, a failure will also occur.

If you do not want to document a path parameter, a parameter descriptor can be marked as IgnorableDescriptor.ignored. This will prevent it from appearing in the generated snippet while avoiding the failure described above.

Parameters:

descriptors - the descriptions of the parameters in the request's path

Returns:

the snippet that will document the parameters

pathParameters

public static Snippet pathParameters(Map<String,Object> attributes,
                                     ParameterDescriptor... descriptors)

Returns a Snippet that will document the path parameters from the API operation's request. The given attributes will be available during snippet rendering and the parameters will be documented using the given descriptors .

If a parameter is present in the request path, but is not documented by one of the descriptors, a failure will occur when the snippet is invoked. Similarly, if a parameter is documented, is not marked as optional, and is not present in the request path, a failure will also occur.

If you do not want to document a path parameter, a parameter descriptor can be marked as IgnorableDescriptor.ignored. This will prevent it from appearing in the generated snippet while avoiding the failure described above.

Parameters:

attributes - the attributes

descriptors - the descriptions of the parameters in the request's path

Returns:

the snippet that will document the parameters

requestParameters

public static Snippet requestParameters(ParameterDescriptor... descriptors)

Returns a Snippet that will document the parameters from the API operation's request. The parameters will be documented using the given descriptors.

If a parameter is present in the request, but is not documented by one of the descriptors, a failure will occur when the snippet is invoked. Similarly, if a parameter is documented, is not marked as optional, and is not present in the request, a failure will also occur.

If you do not want to document a request parameter, a parameter descriptor can be marked as IgnorableDescriptor.ignored. This will prevent it from appearing in the generated snippet while avoiding the failure described above.

Parameters:

descriptors - The descriptions of the request's parameters

Returns:

the snippet

See Also:

OperationRequest.getParameters()

requestParameters

public static Snippet requestParameters(Map<String,Object> attributes,
                                        ParameterDescriptor... descriptors)

Returns a Snippet that will document the parameters from the API operation's request. The given attributes will be available during snippet rendering and the parameters will be documented using the given descriptors .

If a parameter is present in the request, but is not documented by one of the descriptors, a failure will occur when the snippet is invoked. Similarly, if a parameter is documented, is not marked as optional, and is not present in the request, a failure will also occur.

If you do not want to document a request parameter, a parameter descriptor can be marked as IgnorableDescriptor.ignored. This will prevent it from appearing in the generated snippet while avoiding the failure described above.

Parameters:

attributes - the attributes

descriptors - the descriptions of the request's parameters

Returns:

the snippet that will document the parameters

See Also:

OperationRequest.getParameters()