Package | Description |
---|---|
org.springframework.restdocs.cli |
Documenting CLI commands required to make a request to a RESTful API.
|
org.springframework.restdocs.headers |
Documenting the headers of a RESTful API's requests and responses.
|
org.springframework.restdocs.http |
Documenting the HTTP request sent to a RESTful API and the HTTP response that is
returned.
|
org.springframework.restdocs.hypermedia |
Documenting a RESTful API that uses hypermedia.
|
org.springframework.restdocs.payload |
Documenting the payload of a RESTful API's requests and responses.
|
org.springframework.restdocs.request |
Documenting query and path parameters of requests sent to a RESTful API.
|
Modifier and Type | Class and Description |
---|---|
class |
CurlRequestSnippet
A
Snippet that documents the curl command for a request. |
class |
HttpieRequestSnippet
A
Snippet that documents the HTTPie command for a request. |
Modifier and Type | Class and Description |
---|---|
class |
AbstractHeadersSnippet
Abstract
TemplatedSnippet subclass that provides a base for snippets that
document a RESTful resource's request or response headers. |
class |
RequestHeadersSnippet
A
Snippet that documents the headers in a request. |
class |
ResponseHeadersSnippet
A
Snippet that documents the headers in a response. |
Modifier and Type | Class and Description |
---|---|
class |
HttpRequestSnippet
A
Snippet that documents an HTTP request. |
class |
HttpResponseSnippet
A
Snippet that documents an HTTP response. |
Modifier and Type | Class and Description |
---|---|
class |
LinksSnippet
A
Snippet that documents a RESTful resource's links. |
Modifier and Type | Class and Description |
---|---|
class |
AbstractBodySnippet
Abstract
TemplatedSnippet subclass that provides a base for snippets that
document a RESTful resource's request or response body. |
class |
AbstractFieldsSnippet
Abstract
TemplatedSnippet subclass that provides a base for snippets that
document a RESTful resource's request or response fields. |
class |
RequestBodySnippet
A
Snippet that documents the body of a request. |
class |
RequestFieldsSnippet
A
Snippet that documents the fields in a request. |
class |
RequestPartBodySnippet
A
Snippet that documents the body of a request part. |
class |
RequestPartFieldsSnippet
A
Snippet that documents the fields in a request part. |
class |
ResponseBodySnippet
A
Snippet that documents the body of a response. |
class |
ResponseFieldsSnippet
A
Snippet that documents the fields in a response. |
Modifier and Type | Class and Description |
---|---|
class |
AbstractParametersSnippet
Abstract
TemplatedSnippet subclass that provides a base for snippets that
document parameters from a request sent to a RESTful resource. |
class |
PathParametersSnippet
A
Snippet that documents the path parameters supported by a RESTful resource. |
class |
RequestParametersSnippet
A
Snippet that documents the request parameters supported by a RESTful
resource. |
class |
RequestPartsSnippet
A
Snippet that documents the request parts supported by a RESTful resource. |