Uses of Interface
org.springframework.restdocs.operation.preprocess.OperationRequestPreprocessor
Package
Description
Classes that drive the generation of the documentation snippets.
Core classes for using Spring REST Docs with Spring Test's MockMvc.
Support for preprocessing an operation prior to it being documented.
Core classes for using Spring REST Docs with REST Assured.
Core classes for using Spring REST Docs with Spring Framework's WebTestClient.
-
Uses of OperationRequestPreprocessor in org.springframework.restdocs.generate
ModifierConstructorDescriptionRestDocumentationGenerator
(String identifier, RequestConverter<REQ> requestConverter, ResponseConverter<RESP> responseConverter, OperationRequestPreprocessor requestPreprocessor, OperationResponsePreprocessor responsePreprocessor, Snippet... snippets) Creates a newRestDocumentationGenerator
for the operation identified by the givenidentifier
.RestDocumentationGenerator
(String identifier, RequestConverter<REQ> requestConverter, ResponseConverter<RESP> responseConverter, OperationRequestPreprocessor requestPreprocessor, Snippet... snippets) Creates a newRestDocumentationGenerator
for the operation identified by the givenidentifier
. -
Uses of OperationRequestPreprocessor in org.springframework.restdocs.mockmvc
Modifier and TypeMethodDescriptionMockMvcRestDocumentation.document
(String identifier, OperationRequestPreprocessor requestPreprocessor, OperationResponsePreprocessor responsePreprocessor, Snippet... snippets) Documents the API call with the givenidentifier
using the givensnippets
in addition to any default snippets.MockMvcRestDocumentation.document
(String identifier, OperationRequestPreprocessor requestPreprocessor, Snippet... snippets) Documents the API call with the givenidentifier
using the givensnippets
in addition to any default snippets. -
Uses of OperationRequestPreprocessor in org.springframework.restdocs.operation.preprocess
Modifier and TypeMethodDescriptionstatic OperationRequestPreprocessor
Preprocessors.preprocessRequest
(OperationPreprocessor... preprocessors) Returns anOperationRequestPreprocessor
that will preprocess the request by applying the givenpreprocessors
to it. -
Uses of OperationRequestPreprocessor in org.springframework.restdocs.restassured
Modifier and TypeMethodDescriptionstatic RestDocumentationFilter
RestAssuredRestDocumentation.document
(String identifier, OperationRequestPreprocessor requestPreprocessor, OperationResponsePreprocessor responsePreprocessor, Snippet... snippets) Documents the API call with the givenidentifier
using the givensnippets
in addition to any default snippets.static RestDocumentationFilter
RestAssuredRestDocumentation.document
(String identifier, OperationRequestPreprocessor requestPreprocessor, Snippet... snippets) Documents the API call with the givenidentifier
using the givensnippets
in addition to any default snippets. -
Uses of OperationRequestPreprocessor in org.springframework.restdocs.webtestclient
Modifier and TypeMethodDescriptionstatic <T extends org.springframework.test.web.reactive.server.ExchangeResult>
Consumer<T>WebTestClientRestDocumentation.document
(String identifier, OperationRequestPreprocessor requestPreprocessor, OperationResponsePreprocessor responsePreprocessor, Snippet... snippets) Documents the API call with the givenidentifier
using the givensnippets
in addition to any default snippets.static <T extends org.springframework.test.web.reactive.server.ExchangeResult>
Consumer<T>WebTestClientRestDocumentation.document
(String identifier, OperationRequestPreprocessor requestPreprocessor, Snippet... snippets) Documents the API call with the givenidentifier
using the givensnippets
in addition to any default snippets.