Package | Description |
---|---|
org.springframework.restdocs.headers |
Documenting the headers of a RESTful API's requests and responses.
|
Modifier and Type | Method and Description |
---|---|
ResponseHeadersSnippet |
ResponseHeadersSnippet.and(HeaderDescriptor... additionalDescriptors)
Returns a new
ResponseHeadersSnippet configured with this snippet's
attributes and its descriptors combined with the given
additionalDescriptors . |
ResponseHeadersSnippet |
ResponseHeadersSnippet.and(java.util.List<HeaderDescriptor> additionalDescriptors)
Returns a new
ResponseHeadersSnippet configured with this snippet's
attributes and its descriptors combined with the given
additionalDescriptors . |
static ResponseHeadersSnippet |
HeaderDocumentation.responseHeaders(HeaderDescriptor... descriptors)
Returns a new
Snippet that will document the headers of the API operation's
response. |
static ResponseHeadersSnippet |
HeaderDocumentation.responseHeaders(java.util.List<HeaderDescriptor> descriptors)
Returns a new
Snippet that will document the headers of the API operation's
response. |
static ResponseHeadersSnippet |
HeaderDocumentation.responseHeaders(java.util.Map<java.lang.String,java.lang.Object> attributes,
HeaderDescriptor... descriptors)
Returns a new
Snippet that will document the headers of the API
operations's response. |
static ResponseHeadersSnippet |
HeaderDocumentation.responseHeaders(java.util.Map<java.lang.String,java.lang.Object> attributes,
java.util.List<HeaderDescriptor> descriptors)
Returns a new
Snippet that will document the headers of the API
operations's response. |