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