Class WebTestClientRestDocumentationConfigurer
java.lang.Object
org.springframework.restdocs.config.RestDocumentationConfigurer<WebTestClientSnippetConfigurer,WebTestClientOperationPreprocessorsConfigurer,WebTestClientRestDocumentationConfigurer>
org.springframework.restdocs.webtestclient.WebTestClientRestDocumentationConfigurer
- All Implemented Interfaces:
org.springframework.web.reactive.function.client.ExchangeFilterFunction
public class WebTestClientRestDocumentationConfigurer
extends RestDocumentationConfigurer<WebTestClientSnippetConfigurer,WebTestClientOperationPreprocessorsConfigurer,WebTestClientRestDocumentationConfigurer>
implements org.springframework.web.reactive.function.client.ExchangeFilterFunction
A WebFlux-specific
RestDocumentationConfigurer.- Since:
- 2.0.0
- Author:
- Andy Wilkinson
-
Method Summary
Modifier and TypeMethodDescriptionreactor.core.publisher.Mono<org.springframework.web.reactive.function.client.ClientResponse>filter(org.springframework.web.reactive.function.client.ClientRequest request, org.springframework.web.reactive.function.client.ExchangeFunction next) Returns anOperationPreprocessorsConfigurerthat can be used to configure the operation request and response preprocessors that will be used.snippets()Returns aSnippetConfigurerthat can be used to configure the snippets that will be generated.Methods inherited from class org.springframework.restdocs.config.RestDocumentationConfigurer
apply, templateEngine, writerResolverMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.springframework.web.reactive.function.client.ExchangeFilterFunction
andThen, apply
-
Method Details
-
snippets
Description copied from class:RestDocumentationConfigurerReturns aSnippetConfigurerthat can be used to configure the snippets that will be generated.- Specified by:
snippetsin classRestDocumentationConfigurer<WebTestClientSnippetConfigurer,WebTestClientOperationPreprocessorsConfigurer, WebTestClientRestDocumentationConfigurer> - Returns:
- the snippet configurer
-
operationPreprocessors
Description copied from class:RestDocumentationConfigurerReturns anOperationPreprocessorsConfigurerthat can be used to configure the operation request and response preprocessors that will be used.- Specified by:
operationPreprocessorsin classRestDocumentationConfigurer<WebTestClientSnippetConfigurer,WebTestClientOperationPreprocessorsConfigurer, WebTestClientRestDocumentationConfigurer> - Returns:
- the operation preprocessors configurer
-
filter
public reactor.core.publisher.Mono<org.springframework.web.reactive.function.client.ClientResponse> filter(org.springframework.web.reactive.function.client.ClientRequest request, org.springframework.web.reactive.function.client.ExchangeFunction next) - Specified by:
filterin interfaceorg.springframework.web.reactive.function.client.ExchangeFilterFunction
-