Class RequestParametersSnippet
java.lang.Object
org.springframework.restdocs.snippet.TemplatedSnippet
org.springframework.restdocs.request.AbstractParametersSnippet
org.springframework.restdocs.request.RequestParametersSnippet
- All Implemented Interfaces:
Snippet
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.
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedRequestParametersSnippet(List<ParameterDescriptor> descriptors) Creates a newRequestParametersSnippetthat will document the request's parameters using the givendescriptors.protectedRequestParametersSnippet(List<ParameterDescriptor> descriptors, boolean ignoreUndocumentedParameters) Creates a newRequestParametersSnippetthat will document the request's parameters using the givendescriptors.protectedRequestParametersSnippet(List<ParameterDescriptor> descriptors, Map<String, Object> attributes) Creates a newRequestParametersSnippetthat will document the request's parameters using the givendescriptors.protectedRequestParametersSnippet(List<ParameterDescriptor> descriptors, Map<String, Object> attributes, boolean ignoreUndocumentedParameters) Creates a newRequestParametersSnippetthat will document the request's parameters using the givendescriptors. -
Method Summary
Modifier and TypeMethodDescriptionand(List<ParameterDescriptor> additionalDescriptors) Returns a newRequestParametersSnippetconfigured with this snippet's attributes and its descriptors combined with the givenadditionalDescriptors.and(ParameterDescriptor... additionalDescriptors) Returns a newRequestParametersSnippetconfigured with this snippet's attributes and its descriptors combined with the givenadditionalDescriptors.extractActualParameters(Operation operation) Extracts the names of the parameters that were present in the givenoperation.protected voidverificationFailed(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, getParameterDescriptors, isIgnoreUndocumentedParametersMethods inherited from class org.springframework.restdocs.snippet.TemplatedSnippet
document, getAttributes, getSnippetName
-
Constructor Details
-
RequestParametersSnippet
Creates a newRequestParametersSnippetthat will document the request's parameters using the givendescriptors. Undocumented parameters will trigger a failure.- Parameters:
descriptors- the parameter descriptors
-
RequestParametersSnippet
protected RequestParametersSnippet(List<ParameterDescriptor> descriptors, boolean ignoreUndocumentedParameters) Creates a newRequestParametersSnippetthat will document the request's parameters using the givendescriptors. IfignoreUndocumentedParametersistrue, undocumented parameters will be ignored and will not trigger a failure.- Parameters:
descriptors- the parameter descriptorsignoreUndocumentedParameters- whether undocumented parameters should be ignored
-
RequestParametersSnippet
protected RequestParametersSnippet(List<ParameterDescriptor> descriptors, Map<String, Object> attributes) Creates a newRequestParametersSnippetthat will document the request's parameters using the givendescriptors. The givenattributeswill be included in the model during template rendering. Undocumented parameters will trigger a failure.- Parameters:
descriptors- the parameter descriptorsattributes- the additional attributes
-
RequestParametersSnippet
protected RequestParametersSnippet(List<ParameterDescriptor> descriptors, Map<String, Object> attributes, boolean ignoreUndocumentedParameters) Creates a newRequestParametersSnippetthat will document the request's parameters using the givendescriptors. The givenattributeswill be included in the model during template rendering. IfignoreUndocumentedParametersistrue, undocumented parameters will be ignored and will not trigger a failure.- Parameters:
descriptors- the parameter descriptorsattributes- the additional attributesignoreUndocumentedParameters- whether undocumented parameters should be ignored
-
-
Method Details
-
verificationFailed
protected void verificationFailed(Set<String> undocumentedParameters, Set<String> missingParameters) Description copied from class:AbstractParametersSnippetCalled when the documented parameters do not match the actual parameters.- Specified by:
verificationFailedin classAbstractParametersSnippet- Parameters:
undocumentedParameters- the parameters that were found in the operation but were not documentedmissingParameters- the parameters that were documented but were not found in the operation
-
extractActualParameters
Description copied from class:AbstractParametersSnippetExtracts the names of the parameters that were present in the givenoperation.- Specified by:
extractActualParametersin classAbstractParametersSnippet- Parameters:
operation- the operation- Returns:
- the parameters
-
and
Returns a newRequestParametersSnippetconfigured with this snippet's attributes and its descriptors combined with the givenadditionalDescriptors.- Parameters:
additionalDescriptors- the additional descriptors- Returns:
- the new snippet
-
and
Returns a newRequestParametersSnippetconfigured with this snippet's attributes and its descriptors combined with the givenadditionalDescriptors.- Parameters:
additionalDescriptors- the additional descriptors- Returns:
- the new snippet
-