WebTestClientRestDocumentationConfigurer (Spring REST Docs 4.0.1-SNAPSHOT API)

java.lang.Object

org.springframework.restdocs.config.RestDocumentationConfigurer<WebTestClientSnippetConfigurer, WebTestClientOperationPreprocessorsConfigurer, WebTestClientRestDocumentationConfigurer>

org.springframework.restdocs.webtestclient.WebTestClientRestDocumentationConfigurer

All Implemented Interfaces:: ExchangeFilterFunction

public class WebTestClientRestDocumentationConfigurer extends RestDocumentationConfigurer<WebTestClientSnippetConfigurer, WebTestClientOperationPreprocessorsConfigurer, WebTestClientRestDocumentationConfigurer> implements ExchangeFilterFunction

A WebFlux-specific RestDocumentationConfigurer.

Since:: 2.0.0
Author:: Andy Wilkinson

Method Summary

Modifier and Type

Method

Description

reactor.core.publisher.Mono<ClientResponse>

filter(ClientRequest request, ExchangeFunction next)

WebTestClientOperationPreprocessorsConfigurer

operationPreprocessors()

Returns an OperationPreprocessorsConfigurer that can be used to configure the operation request and response preprocessors that will be used.

WebTestClientSnippetConfigurer

snippets()

Returns a SnippetConfigurer that can be used to configure the snippets that will be generated.

Methods inherited from class RestDocumentationConfigurer
apply, templateEngine, writerResolver

Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface ExchangeFilterFunction
andThen, apply

Method Details
- snippets
  
  public WebTestClientSnippetConfigurer snippets()
  
  Description copied from class: RestDocumentationConfigurer
  
  Returns a SnippetConfigurer that can be used to configure the snippets that will be generated.
  
  Specified by:
  
  snippets in class RestDocumentationConfigurer<WebTestClientSnippetConfigurer, WebTestClientOperationPreprocessorsConfigurer, WebTestClientRestDocumentationConfigurer>
  
  Returns:
  
  the snippet configurer
- operationPreprocessors
  
  public WebTestClientOperationPreprocessorsConfigurer operationPreprocessors()
  
  Description copied from class: RestDocumentationConfigurer
  
  Returns an OperationPreprocessorsConfigurer that can be used to configure the operation request and response preprocessors that will be used.
  
  Specified by:
  
  operationPreprocessors in class RestDocumentationConfigurer<WebTestClientSnippetConfigurer, WebTestClientOperationPreprocessorsConfigurer, WebTestClientRestDocumentationConfigurer>
  
  Returns:
  
  the operation preprocessors configurer
- filter
  
  public reactor.core.publisher.Mono<ClientResponse> filter(ClientRequest request, ExchangeFunction next)
  
  Specified by:
  
  filter in interface ExchangeFilterFunction