org.springframework.restdocs.request

Class RequestParametersSnippet

java.lang.Object

org.springframework.restdocs.snippet.TemplatedSnippet

org.springframework.restdocs.request.AbstractParametersSnippet

org.springframework.restdocs.request.RequestParametersSnippet

All Implemented Interfaces:

Snippet

public class RequestParametersSnippet
extends AbstractParametersSnippet

A Snippet that documents the request parameters supported by a RESTful resource.

Request parameters are sent as part of the query string or as POSTed form data.

Author:

Andy Wilkinson

See Also:

OperationRequest.getParameters(), RequestDocumentation.requestParameters(ParameterDescriptor...), RequestDocumentation.requestParameters(Map, ParameterDescriptor...)

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RequestParametersSnippet(List<ParameterDescriptor> descriptors) Creates a new RequestParametersSnippet that will document the request's parameters using the given descriptors.
protected	RequestParametersSnippet(List<ParameterDescriptor> descriptors, Map<String,Object> attributes) Creates a new RequestParametersSnippet that will document the request's parameters using the given descriptors.

Method Summary

Modifier and Type	Method and Description
protected Set<String>	extractActualParameters(Operation operation) Extracts the names of the parameters that were present in the given operation.
protected void	verificationFailed(Set<String> undocumentedParameters, Set<String> missingParameters) Called when the documented parameters do not match the actual parameters.

Methods inherited from class org.springframework.restdocs.request.AbstractParametersSnippet

createModel, createModelForDescriptor, getFieldDescriptors

Methods inherited from class org.springframework.restdocs.snippet.TemplatedSnippet

document, getAttributes, getSnippetName

Methods inherited from class java.lang.Object

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

Constructor Detail

RequestParametersSnippet

protected RequestParametersSnippet(List<ParameterDescriptor> descriptors)

Creates a new RequestParametersSnippet that will document the request's parameters using the given descriptors.

Parameters:

descriptors - the parameter descriptors

RequestParametersSnippet

protected RequestParametersSnippet(List<ParameterDescriptor> descriptors,
                                   Map<String,Object> attributes)

Creates a new RequestParametersSnippet that will document the request's parameters using the given descriptors. The given attributes will be included in the model during template rendering.

Parameters:

descriptors - the parameter descriptors

attributes - the additional attributes

Method Detail

verificationFailed

protected void verificationFailed(Set<String> undocumentedParameters,
                                  Set<String> missingParameters)

Description copied from class: AbstractParametersSnippet

Called when the documented parameters do not match the actual parameters.

Specified by:

verificationFailed in class AbstractParametersSnippet

Parameters:

undocumentedParameters - the parameters that were found in the operation but were not documented

missingParameters - the parameters that were documented but were not found in the operation

extractActualParameters

protected Set<String> extractActualParameters(Operation operation)

Description copied from class: AbstractParametersSnippet

Extracts the names of the parameters that were present in the given operation.

Specified by:

extractActualParameters in class AbstractParametersSnippet

Parameters:

operation - the operation

Returns:

the parameters