Uses of Class
org.springframework.restdocs.request.PathParametersSnippet
Package
Description
Documenting query and path parameters of requests sent to a RESTful API.
-
Uses of PathParametersSnippet in org.springframework.restdocs.request
Modifier and TypeMethodDescriptionfinal PathParametersSnippet
PathParametersSnippet.and
(List<ParameterDescriptor> additionalDescriptors) Returns a newPathParametersSnippet
configured with this snippet's attributes and its descriptors combined with the givenadditionalDescriptors
.final PathParametersSnippet
PathParametersSnippet.and
(ParameterDescriptor... additionalDescriptors) Returns a newPathParametersSnippet
configured with this snippet's attributes and its descriptors combined with the givenadditionalDescriptors
.static PathParametersSnippet
RequestDocumentation.pathParameters
(List<ParameterDescriptor> descriptors) Returns aSnippet
that will document the path parameters from the API operation's request.static PathParametersSnippet
RequestDocumentation.pathParameters
(Map<String, Object> attributes, List<ParameterDescriptor> descriptors) Returns aSnippet
that will document the path parameters from the API operation's request.static PathParametersSnippet
RequestDocumentation.pathParameters
(Map<String, Object> attributes, ParameterDescriptor... descriptors) Returns aSnippet
that will document the path parameters from the API operation's request.static PathParametersSnippet
RequestDocumentation.pathParameters
(ParameterDescriptor... descriptors) Returns aSnippet
that will document the path parameters from the API operation's request.static PathParametersSnippet
RequestDocumentation.relaxedPathParameters
(List<ParameterDescriptor> descriptors) Returns aSnippet
that will document the path parameters from the API operation's request.static PathParametersSnippet
RequestDocumentation.relaxedPathParameters
(Map<String, Object> attributes, List<ParameterDescriptor> descriptors) Returns aSnippet
that will document the path parameters from the API operation's request.static PathParametersSnippet
RequestDocumentation.relaxedPathParameters
(Map<String, Object> attributes, ParameterDescriptor... descriptors) Returns aSnippet
that will document the path parameters from the API operation's request.static PathParametersSnippet
RequestDocumentation.relaxedPathParameters
(ParameterDescriptor... descriptors) Returns aSnippet
that will document the path parameters from the API operation's request.