Uses of Interface
org.springframework.restdocs.operation.preprocess.OperationRequestPreprocessor
Packages that use 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
Constructors in org.springframework.restdocs.generate with parameters of type OperationRequestPreprocessorModifierConstructorDescriptionRestDocumentationGenerator(String identifier, RequestConverter<REQ> requestConverter, ResponseConverter<RESP> responseConverter, OperationRequestPreprocessor requestPreprocessor, OperationResponsePreprocessor responsePreprocessor, Snippet... snippets) Creates a newRestDocumentationGeneratorfor the operation identified by the givenidentifier.RestDocumentationGenerator(String identifier, RequestConverter<REQ> requestConverter, ResponseConverter<RESP> responseConverter, OperationRequestPreprocessor requestPreprocessor, Snippet... snippets) Creates a newRestDocumentationGeneratorfor the operation identified by the givenidentifier. -
Uses of OperationRequestPreprocessor in org.springframework.restdocs.mockmvc
Methods in org.springframework.restdocs.mockmvc with parameters of type OperationRequestPreprocessorModifier and TypeMethodDescriptionMockMvcRestDocumentation.document(String identifier, OperationRequestPreprocessor requestPreprocessor, OperationResponsePreprocessor responsePreprocessor, Snippet... snippets) Documents the API call with the givenidentifierusing the givensnippetsin addition to any default snippets.MockMvcRestDocumentation.document(String identifier, OperationRequestPreprocessor requestPreprocessor, Snippet... snippets) Documents the API call with the givenidentifierusing the givensnippetsin addition to any default snippets. -
Uses of OperationRequestPreprocessor in org.springframework.restdocs.operation.preprocess
Methods in org.springframework.restdocs.operation.preprocess that return OperationRequestPreprocessorModifier and TypeMethodDescriptionstatic OperationRequestPreprocessorPreprocessors.preprocessRequest(OperationPreprocessor... preprocessors) Returns anOperationRequestPreprocessorthat will preprocess the request by applying the givenpreprocessorsto it. -
Uses of OperationRequestPreprocessor in org.springframework.restdocs.restassured
Methods in org.springframework.restdocs.restassured with parameters of type OperationRequestPreprocessorModifier and TypeMethodDescriptionstatic RestDocumentationFilterRestAssuredRestDocumentation.document(String identifier, OperationRequestPreprocessor requestPreprocessor, OperationResponsePreprocessor responsePreprocessor, Snippet... snippets) Documents the API call with the givenidentifierusing the givensnippetsin addition to any default snippets.static RestDocumentationFilterRestAssuredRestDocumentation.document(String identifier, OperationRequestPreprocessor requestPreprocessor, Snippet... snippets) Documents the API call with the givenidentifierusing the givensnippetsin addition to any default snippets. -
Uses of OperationRequestPreprocessor in org.springframework.restdocs.webtestclient
Methods in org.springframework.restdocs.webtestclient with parameters of type OperationRequestPreprocessorModifier 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 givenidentifierusing the givensnippetsin 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 givenidentifierusing the givensnippetsin addition to any default snippets.