Package | Description |
---|---|
org.springframework.restdocs.payload |
Documenting the payload of a RESTful API's requests and responses.
|
Class and Description |
---|
AbstractBodySnippet
Abstract
TemplatedSnippet subclass that provides a base for snippets that
document a RESTful resource's request or response body. |
AbstractFieldsSnippet
Abstract
TemplatedSnippet subclass that provides a base for snippets that
document a RESTful resource's request or response fields. |
FieldDescriptor
A description of a field found in a request or response payload.
|
FieldPathPayloadSubsectionExtractor
A
PayloadSubsectionExtractor that extracts the subsection of the JSON payload
identified by a field path. |
FieldTypeResolver
Resolves the type of a field in a request or response payload.
|
JsonFieldType
An enumeration of the possible types for a field in a JSON request or response payload.
|
PayloadSubsectionExtractor
Strategy interface for extracting a subsection of a payload.
|
RequestBodySnippet
A
Snippet that documents the body of a request. |
RequestFieldsSnippet
A
Snippet that documents the fields in a request. |
RequestPartBodySnippet
A
Snippet that documents the body of a request part. |
RequestPartFieldsSnippet
A
Snippet that documents the fields in a request part. |
ResponseBodySnippet
A
Snippet that documents the body of a response. |
ResponseFieldsSnippet
A
Snippet that documents the fields in a response. |
SubsectionDescriptor
A description of a subsection, i.e.
|