| Package | Description |
|---|---|
| org.springframework.restdocs.cli |
Documenting CLI commands required to make a request to a RESTful API.
|
| org.springframework.restdocs.config |
Classes for configuring Spring REST Docs.
|
| org.springframework.restdocs.generate |
Classes that drive the generation of the documentation snippets.
|
| 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.mockmvc |
Core classes for using Spring REST Docs with Spring Test's MockMvc.
|
| 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.restassured3 |
Core classes for using Spring REST Docs with REST Assured 3.
|
| org.springframework.restdocs.snippet |
Snippet generation.
|
| org.springframework.restdocs.webtestclient |
Core classes for using Spring REST Docs with Spring Framework's WebTestClient.
|
| Class and Description |
|---|
| Snippet
A
Snippet is used to document aspects of a call to a RESTful API. |
| TemplatedSnippet |
| Class and Description |
|---|
| Snippet
A
Snippet is used to document aspects of a call to a RESTful API. |
| WriterResolver
A
WriterResolver is used to access the Writer that should be used to
write a snippet for an operation that is being documented. |
| Class and Description |
|---|
| Snippet
A
Snippet is used to document aspects of a call to a RESTful API. |
| Class and Description |
|---|
| AbstractDescriptor
Base class for descriptors.
|
| Snippet
A
Snippet is used to document aspects of a call to a RESTful API. |
| TemplatedSnippet |
| Class and Description |
|---|
| Snippet
A
Snippet is used to document aspects of a call to a RESTful API. |
| TemplatedSnippet |
| Class and Description |
|---|
| AbstractDescriptor
Base class for descriptors.
|
| IgnorableDescriptor
Base class for descriptors for items that can be ignored.
|
| Snippet
A
Snippet is used to document aspects of a call to a RESTful API. |
| TemplatedSnippet |
| Class and Description |
|---|
| Snippet
A
Snippet is used to document aspects of a call to a RESTful API. |
| Class and Description |
|---|
| AbstractDescriptor
Base class for descriptors.
|
| IgnorableDescriptor
Base class for descriptors for items that can be ignored.
|
| Snippet
A
Snippet is used to document aspects of a call to a RESTful API. |
| TemplatedSnippet |
| Class and Description |
|---|
| AbstractDescriptor
Base class for descriptors.
|
| IgnorableDescriptor
Base class for descriptors for items that can be ignored.
|
| Snippet
A
Snippet is used to document aspects of a call to a RESTful API. |
| TemplatedSnippet |
| Class and Description |
|---|
| Snippet
A
Snippet is used to document aspects of a call to a RESTful API. |
| Class and Description |
|---|
| AbstractDescriptor
Base class for descriptors.
|
| Attributes.Attribute
An attribute (key-value pair).
|
| Attributes.AttributeBuilder
A simple builder for an attribute (key-value pair).
|
| IgnorableDescriptor
Base class for descriptors for items that can be ignored.
|
| PlaceholderResolverFactory
A factory for creating
PropertyPlaceholderHelper.PlaceholderResolver instances. |
| Snippet
A
Snippet is used to document aspects of a call to a RESTful API. |
| WriterResolver
A
WriterResolver is used to access the Writer that should be used to
write a snippet for an operation that is being documented. |
| Class and Description |
|---|
| Snippet
A
Snippet is used to document aspects of a call to a RESTful API. |