Uses of Interface
org.springframework.restdocs.operation.preprocess.OperationPreprocessor
Package
Description
Classes for configuring Spring REST Docs.
Support for preprocessing an operation prior to it being documented.
-
Uses of OperationPreprocessor in org.springframework.restdocs.config
Modifier and TypeMethodDescriptionOperationPreprocessorsConfigurer.withRequestDefaults
(OperationPreprocessor... preprocessors) Configures the default operation request preprocessors.OperationPreprocessorsConfigurer.withResponseDefaults
(OperationPreprocessor... preprocessors) Configures the default operation response preprocessors. -
Uses of OperationPreprocessor in org.springframework.restdocs.operation.preprocess
Modifier and TypeClassDescriptionclass
AnOperationPreprocessor
that applies aContentModifier
to the content of the request or response.class
An implementation ofOperationPreprocessor
that returns the request and response as-is.final class
AnOperationPreprocessor
that can be used to modify a request'sOperationRequest.getParameters()
by adding, setting, and removing parameters.class
AnOperationPreprocessor
that modifies URIs in the request and in the response by changing one or more of their host, scheme, and port.Modifier and TypeMethodDescriptionstatic OperationPreprocessor
Preprocessors.maskLinks()
Returns anOperationPreprocessor
that will mask the href of hypermedia links in the request or response.static OperationPreprocessor
Returns anOperationPreprocessor
that will mask the href of hypermedia links in the request or response.static OperationPreprocessor
Preprocessors.prettyPrint()
Returns anOperationPreprocessor
that will pretty print the content of the request or response.static OperationPreprocessor
Preprocessors.removeHeaders
(String... headerNames) Returns anOperationPreprocessor
that will remove any header from the request or response with a name that is equal to one of the givenheadersToRemove
.static OperationPreprocessor
Preprocessors.removeMatchingHeaders
(String... headerNamePatterns) Returns anOperationPreprocessor
that will remove any headers from the request or response with a name that matches one of the givenheaderNamePatterns
regular expressions.static OperationPreprocessor
Preprocessors.replacePattern
(Pattern pattern, String replacement) Returns anOperationPreprocessor
that will modify the content of the request or response by replacing occurrences of the givenpattern
with the givenreplacement
.Modifier and TypeMethodDescriptionstatic OperationRequestPreprocessor
Preprocessors.preprocessRequest
(OperationPreprocessor... preprocessors) Returns anOperationRequestPreprocessor
that will preprocess the request by applying the givenpreprocessors
to it.Preprocessors.preprocessResponse
(OperationPreprocessor... preprocessors) Returns anOperationResponsePreprocessor
that will preprocess the response by applying the givenpreprocessors
to it.