Package | Description |
---|---|
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.
|
org.springframework.restdocs.snippet |
Snippet generation.
|
Modifier and Type | Class and Description |
---|---|
class |
LinkDescriptor
A description of a link found in a hypermedia API.
|
Modifier and Type | Class and Description |
---|---|
class |
FieldDescriptor
A description of a field found in a request or response payload.
|
class |
SubsectionDescriptor
A description of a subsection, i.e.
|
Modifier and Type | Class and Description |
---|---|
class |
ParameterDescriptor
A descriptor of a request or path parameter.
|
class |
RequestPartDescriptor
A descriptor of a request part.
|
Modifier and Type | Class and Description |
---|---|
class |
IgnorableDescriptor<T extends IgnorableDescriptor<T>>
Base class for descriptors for items that can be ignored.
|