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 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.

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 call's request.

Parameters:

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

Returns:

the snippet

See Also:

PathVariable

pathParameters

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

Returns a snippet that will document the path parameters from the API call's request. The given attributes will be available during snippet rendering.

Parameters:

attributes - Attributes made available during rendering of the path parameters snippet

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

Returns:

the snippet

See Also:

PathVariable

requestParameters

public static Snippet requestParameters(ParameterDescriptor... descriptors)

Returns a snippet that will document the request parameters from the API call's request.

Parameters:

descriptors - The descriptions of the request's parameters

Returns:

the snippet

See Also:

RequestParam, ServletRequest.getParameterMap()

requestParameters

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

Returns a snippet that will document the request parameters from the API call's request. The given attributes will be available during snippet rendering.

Parameters:

attributes - Attributes made available during rendering of the request parameters snippet

descriptors - The descriptions of the request's parameters

Returns:

the snippet

See Also:

RequestParam, ServletRequest.getParameterMap()