Package | Description |
---|---|
org.springframework.restdocs.request |
Documenting query and path parameters of requests sent to a RESTful API.
|
Modifier and Type | Method and Description |
---|---|
RequestParametersSnippet |
RequestParametersSnippet.and(java.util.List<ParameterDescriptor> additionalDescriptors)
Returns a new
RequestParametersSnippet configured with this snippet's
attributes and its descriptors combined with the given
additionalDescriptors . |
RequestParametersSnippet |
RequestParametersSnippet.and(ParameterDescriptor... additionalDescriptors)
Returns a new
RequestParametersSnippet configured with this snippet's
attributes and its descriptors combined with the given
additionalDescriptors . |
static RequestParametersSnippet |
RequestDocumentation.relaxedRequestParameters(java.util.List<ParameterDescriptor> descriptors)
Returns a
Snippet that will document the parameters from the API
operation's request. |
static RequestParametersSnippet |
RequestDocumentation.relaxedRequestParameters(java.util.Map<java.lang.String,java.lang.Object> attributes,
java.util.List<ParameterDescriptor> descriptors)
Returns a
Snippet that will document the parameters from the API
operation's request. |
static RequestParametersSnippet |
RequestDocumentation.relaxedRequestParameters(java.util.Map<java.lang.String,java.lang.Object> attributes,
ParameterDescriptor... descriptors)
Returns a
Snippet that will document the parameters from the API
operation's request. |
static RequestParametersSnippet |
RequestDocumentation.relaxedRequestParameters(ParameterDescriptor... descriptors)
Returns a
Snippet that will document the parameters from the API
operation's request. |
static RequestParametersSnippet |
RequestDocumentation.requestParameters(java.util.List<ParameterDescriptor> descriptors)
Returns a
Snippet that will document the parameters from the API
operation's request. |
static RequestParametersSnippet |
RequestDocumentation.requestParameters(java.util.Map<java.lang.String,java.lang.Object> attributes,
java.util.List<ParameterDescriptor> descriptors)
Returns a
Snippet that will document the parameters from the API
operation's request. |
static RequestParametersSnippet |
RequestDocumentation.requestParameters(java.util.Map<java.lang.String,java.lang.Object> attributes,
ParameterDescriptor... descriptors)
Returns a
Snippet that will document the parameters from the API
operation's request. |
static RequestParametersSnippet |
RequestDocumentation.requestParameters(ParameterDescriptor... descriptors)
Returns a
Snippet that will document the parameters from the API
operation's request. |