| Package | Description |
|---|---|
| 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.mockmvc |
Core classes for using Spring REST Docs with Spring Test's MockMvc.
|
| org.springframework.restdocs.operation.preprocess |
Support for preprocessing an operation prior to it being documented.
|
| org.springframework.restdocs.restassured3 |
Core classes for using Spring REST Docs with REST Assured 3.
|
| org.springframework.restdocs.restassured3.operation.preprocess |
REST Assured-specific support for preprocessing an operation prior to it being
documented.
|
| org.springframework.restdocs.webtestclient |
Core classes for using Spring REST Docs with Spring Framework's WebTestClient.
|
| Class and Description |
|---|
| OperationPreprocessor
An
OperationPreprocessor processes the OperationRequest and
OperationResponse of an Operation prior to it being documented. |
| Class and Description |
|---|
| OperationRequestPreprocessor
An
OperationRequestPreprocessor is used to modify an OperationRequest
prior to it being documented. |
| OperationResponsePreprocessor
An
OperationResponsePreprocessor is used to modify an OperationResponse
prior to it being documented. |
| Class and Description |
|---|
| OperationRequestPreprocessor
An
OperationRequestPreprocessor is used to modify an OperationRequest
prior to it being documented. |
| OperationResponsePreprocessor
An
OperationResponsePreprocessor is used to modify an OperationResponse
prior to it being documented. |
| Class and Description |
|---|
| ContentModifier
A
ContentModifier modifies the content of an OperationRequest or
OperationResponse during the preprocessing that is performed prior to
documentation generation. |
| OperationPreprocessor
An
OperationPreprocessor processes the OperationRequest and
OperationResponse of an Operation prior to it being documented. |
| OperationPreprocessorAdapter
An implementation of
OperationPreprocessor that returns the request and
response as-is. |
| OperationRequestPreprocessor
An
OperationRequestPreprocessor is used to modify an OperationRequest
prior to it being documented. |
| OperationResponsePreprocessor
An
OperationResponsePreprocessor is used to modify an OperationResponse
prior to it being documented. |
| ParametersModifyingOperationPreprocessor
An
OperationPreprocessor that can be used to modify a request's
OperationRequest.getParameters() by adding, setting, and removing parameters. |
| UriModifyingOperationPreprocessor
An
OperationPreprocessor that modifies URIs in the request and in the response
by changing one or more of their host, scheme, and port. |
| Class and Description |
|---|
| OperationRequestPreprocessor
An
OperationRequestPreprocessor is used to modify an OperationRequest
prior to it being documented. |
| OperationResponsePreprocessor
An
OperationResponsePreprocessor is used to modify an OperationResponse
prior to it being documented. |
| Class and Description |
|---|
| UriModifyingOperationPreprocessor
An
OperationPreprocessor that modifies URIs in the request and in the response
by changing one or more of their host, scheme, and port. |
| Class and Description |
|---|
| OperationRequestPreprocessor
An
OperationRequestPreprocessor is used to modify an OperationRequest
prior to it being documented. |
| OperationResponsePreprocessor
An
OperationResponsePreprocessor is used to modify an OperationResponse
prior to it being documented. |