org.springframework.restdocs.request

Class PathParametersSnippet

java.lang.Object

org.springframework.restdocs.snippet.TemplatedSnippet

org.springframework.restdocs.request.AbstractParametersSnippet

org.springframework.restdocs.request.PathParametersSnippet

All Implemented Interfaces:

Snippet

public class PathParametersSnippet
extends AbstractParametersSnippet

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

Author:

Andy Wilkinson

See Also:

RequestDocumentation.pathParameters(ParameterDescriptor...), RequestDocumentation.pathParameters(Map, ParameterDescriptor...)

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected Map<String,Object>	createModel(Operation operation) Create the model that should be used during template rendering to document the given operation.
protected Set<String>	extractActualParameters(Operation operation)
protected void	verificationFailed(Set<String> undocumentedParameters, Set<String> missingParameters)

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

createModelForDescriptor, getFieldDescriptors, verifyParameterDescriptors

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

PathParametersSnippet

protected PathParametersSnippet(List<ParameterDescriptor> descriptors)

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

Parameters:

descriptors - the parameter descriptors

PathParametersSnippet

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

Creates a new PathParametersSnippet that will document the request's path 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

createModel

protected Map<String,Object> createModel(Operation operation)

Description copied from class: TemplatedSnippet

Create the model that should be used during template rendering to document the given operation. Any additional attributes that were supplied when this TemplatedSnippet were created will be automatically added to the model prior to rendering.

Overrides:

createModel in class AbstractParametersSnippet

Parameters:

operation - The operation

Returns:

the model

extractActualParameters

protected Set<String> extractActualParameters(Operation operation)

Specified by:

extractActualParameters in class AbstractParametersSnippet

verificationFailed

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

Specified by:

verificationFailed in class AbstractParametersSnippet