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