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 SnippetWritingResultHandler	documentQueryParameters(String outputDir, ParameterDescriptor... descriptors) Creates a SnippetWritingResultHandler that will produce a snippet documenting a request's query parameters
static ParameterDescriptor	parameterWithName(String name) Creates a ParameterDescriptor that describes a query string parameter with the given name.

Methods inherited from class java.lang.Object

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

Method Detail

documentQueryParameters

public static SnippetWritingResultHandler documentQueryParameters(String outputDir,
                                                                  ParameterDescriptor... descriptors)

Creates a SnippetWritingResultHandler that will produce a snippet documenting a request's query parameters

Parameters:

outputDir - The directory to which the snippet should be written

descriptors - The descriptions of the parameters in the request's query string

Returns:

the result handler

See Also:

RestDocumentationResultHandler.withQueryParameters(ParameterDescriptor...)

parameterWithName

public static ParameterDescriptor parameterWithName(String name)

Creates a ParameterDescriptor that describes a query string parameter with the given name.

Parameters:

name - The name of the parameter

Returns:

a ParameterDescriptor ready for further configuration

See Also:

RestDocumentationResultHandler.withQueryParameters(ParameterDescriptor...)