Uses of Class
org.springframework.restdocs.request.ParameterDescriptor
Package
Description
Documenting query and path parameters of requests sent to a RESTful API.
-
Uses of ParameterDescriptor in org.springframework.restdocs.request
Modifier and TypeMethodDescriptionfinal ParameterDescriptor
ParameterDescriptor.optional()
Marks the parameter as optional.static ParameterDescriptor
RequestDocumentation.parameterWithName
(String name) Creates aParameterDescriptor
that describes a request or path parameter with the givenname
.Modifier and TypeMethodDescriptionprotected final Map<String,
ParameterDescriptor> AbstractParametersSnippet.getParameterDescriptors()
Returns aMap
ofParameterDescriptors
that will be used to generate the documentation key by theirgetName()
.Modifier and TypeMethodDescriptionfinal PathParametersSnippet
PathParametersSnippet.and
(ParameterDescriptor... additionalDescriptors) Returns a newPathParametersSnippet
configured with this snippet's attributes and its descriptors combined with the givenadditionalDescriptors
.RequestParametersSnippet.and
(ParameterDescriptor... additionalDescriptors) Returns a newRequestParametersSnippet
configured with this snippet's attributes and its descriptors combined with the givenadditionalDescriptors
.AbstractParametersSnippet.createModelForDescriptor
(ParameterDescriptor descriptor) Returns a model for the givendescriptor
.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
(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.static RequestParametersSnippet
RequestDocumentation.relaxedRequestParameters
(Map<String, Object> attributes, ParameterDescriptor... descriptors) Returns aSnippet
that will document the parameters from the API operation's request.static RequestParametersSnippet
RequestDocumentation.relaxedRequestParameters
(ParameterDescriptor... descriptors) Returns aSnippet
that will document the parameters from the API operation's request.static RequestParametersSnippet
RequestDocumentation.requestParameters
(Map<String, Object> attributes, ParameterDescriptor... descriptors) Returns aSnippet
that will document the parameters from the API operation's request.static RequestParametersSnippet
RequestDocumentation.requestParameters
(ParameterDescriptor... descriptors) Returns aSnippet
that will document the parameters from the API operation's 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
.RequestParametersSnippet.and
(List<ParameterDescriptor> additionalDescriptors) Returns a newRequestParametersSnippet
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.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 RequestParametersSnippet
RequestDocumentation.relaxedRequestParameters
(List<ParameterDescriptor> descriptors) Returns aSnippet
that will document the parameters from the API operation's request.static RequestParametersSnippet
RequestDocumentation.relaxedRequestParameters
(Map<String, Object> attributes, List<ParameterDescriptor> descriptors) Returns aSnippet
that will document the parameters from the API operation's request.static RequestParametersSnippet
RequestDocumentation.requestParameters
(List<ParameterDescriptor> descriptors) Returns aSnippet
that will document the parameters from the API operation's request.static RequestParametersSnippet
RequestDocumentation.requestParameters
(Map<String, Object> attributes, List<ParameterDescriptor> descriptors) Returns aSnippet
that will document the parameters from the API operation's request.ModifierConstructorDescriptionprotected
AbstractParametersSnippet
(String snippetName, List<ParameterDescriptor> descriptors, Map<String, Object> attributes, boolean ignoreUndocumentedParameters) Creates a newAbstractParametersSnippet
that will produce a snippet with the givensnippetName
that will document parameters using the givendescriptors
.protected
PathParametersSnippet
(List<ParameterDescriptor> descriptors) Creates a newPathParametersSnippet
that will document the request's path parameters using the givendescriptors
.protected
PathParametersSnippet
(List<ParameterDescriptor> descriptors, boolean ignoreUndocumentedParameters) Creates a newPathParametersSnippet
that will document the request's path parameters using the givendescriptors
.protected
PathParametersSnippet
(List<ParameterDescriptor> descriptors, Map<String, Object> attributes) Creates a newPathParametersSnippet
that will document the request's path parameters using the givendescriptors
.protected
PathParametersSnippet
(List<ParameterDescriptor> descriptors, Map<String, Object> attributes, boolean ignoreUndocumentedParameters) Creates a newPathParametersSnippet
that will document the request's path parameters using the givendescriptors
.protected
RequestParametersSnippet
(List<ParameterDescriptor> descriptors) Creates a newRequestParametersSnippet
that will document the request's parameters using the givendescriptors
.protected
RequestParametersSnippet
(List<ParameterDescriptor> descriptors, boolean ignoreUndocumentedParameters) Creates a newRequestParametersSnippet
that will document the request's parameters using the givendescriptors
.protected
RequestParametersSnippet
(List<ParameterDescriptor> descriptors, Map<String, Object> attributes) Creates a newRequestParametersSnippet
that will document the request's parameters using the givendescriptors
.protected
RequestParametersSnippet
(List<ParameterDescriptor> descriptors, Map<String, Object> attributes, boolean ignoreUndocumentedParameters) Creates a newRequestParametersSnippet
that will document the request's parameters using the givendescriptors
.