Package | Description |
---|---|
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.webtestclient |
Core classes for using Spring REST Docs with Spring Framework's WebTestClient.
|
Constructor and Description |
---|
RestDocumentationGenerator(java.lang.String identifier,
RequestConverter<REQ> requestConverter,
ResponseConverter<RESP> responseConverter,
OperationRequestPreprocessor requestPreprocessor,
OperationResponsePreprocessor responsePreprocessor,
Snippet... snippets)
Creates a new
RestDocumentationGenerator for the operation identified by
the given identifier . |
RestDocumentationGenerator(java.lang.String identifier,
RequestConverter<REQ> requestConverter,
ResponseConverter<RESP> responseConverter,
OperationResponsePreprocessor responsePreprocessor,
Snippet... snippets)
Creates a new
RestDocumentationGenerator for the operation identified by
the given identifier . |
Modifier and Type | Method and Description |
---|---|
static RestDocumentationResultHandler |
MockMvcRestDocumentation.document(java.lang.String identifier,
OperationRequestPreprocessor requestPreprocessor,
OperationResponsePreprocessor responsePreprocessor,
Snippet... snippets)
Documents the API call with the given
identifier using the given
snippets in addition to any default snippets. |
static RestDocumentationResultHandler |
MockMvcRestDocumentation.document(java.lang.String identifier,
OperationResponsePreprocessor responsePreprocessor,
Snippet... snippets)
Documents the API call with the given
identifier using the given
snippets in addition to any default snippets. |
Modifier and Type | Method and Description |
---|---|
static OperationResponsePreprocessor |
Preprocessors.preprocessResponse(OperationPreprocessor... preprocessors)
Returns an
OperationResponsePreprocessor that will preprocess the response
by applying the given preprocessors to it. |
Modifier and Type | Method and Description |
---|---|
static RestDocumentationFilter |
RestAssuredRestDocumentation.document(java.lang.String identifier,
OperationRequestPreprocessor requestPreprocessor,
OperationResponsePreprocessor responsePreprocessor,
Snippet... snippets)
Documents the API call with the given
identifier using the given
snippets in addition to any default snippets. |
static RestDocumentationFilter |
RestAssuredRestDocumentation.document(java.lang.String identifier,
OperationResponsePreprocessor responsePreprocessor,
Snippet... snippets)
Documents the API call with the given
identifier using the given
snippets in addition to any default snippets. |
Modifier and Type | Method and Description |
---|---|
static <T extends org.springframework.test.web.reactive.server.ExchangeResult> |
WebTestClientRestDocumentation.document(java.lang.String identifier,
OperationRequestPreprocessor requestPreprocessor,
OperationResponsePreprocessor responsePreprocessor,
Snippet... snippets)
Documents the API call with the given
identifier using the given
snippets in addition to any default snippets. |
static <T extends org.springframework.test.web.reactive.server.ExchangeResult> |
WebTestClientRestDocumentation.document(java.lang.String identifier,
OperationResponsePreprocessor responsePreprocessor,
Snippet... snippets)
Documents the API call with the given
identifier using the given
snippets in addition to any default snippets. |