Class RestTestClientRestDocumentationConfigurer

java.lang.Object

org.springframework.restdocs.config.RestDocumentationConfigurer<RestTestClientSnippetConfigurer, RestTestClientOperationPreprocessorsConfigurer, RestTestClientRestDocumentationConfigurer>

org.springframework.restdocs.resttestclient.RestTestClientRestDocumentationConfigurer

All Implemented Interfaces:

ClientHttpRequestInterceptor

public class RestTestClientRestDocumentationConfigurer
extends RestDocumentationConfigurer<RestTestClientSnippetConfigurer, RestTestClientOperationPreprocessorsConfigurer, RestTestClientRestDocumentationConfigurer>
implements ClientHttpRequestInterceptor

A RestTestClient-specific RestDocumentationConfigurer.

Since:

4.1.0

Author:

Andy Wilkinson

Method Summary

Modifier and Type	Method	Description
ClientHttpResponse	intercept(HttpRequest request, byte[] body, ClientHttpRequestExecution execution)
RestTestClientOperationPreprocessorsConfigurer	operationPreprocessors()	Returns an OperationPreprocessorsConfigurer that can be used to configure the operation request and response preprocessors that will be used.
RestTestClientSnippetConfigurer	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 ClientHttpRequestInterceptor

andThen, apply

Method Details

snippets

public RestTestClientSnippetConfigurer 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<RestTestClientSnippetConfigurer, RestTestClientOperationPreprocessorsConfigurer, RestTestClientRestDocumentationConfigurer>

Returns:

the snippet configurer

operationPreprocessors

public RestTestClientOperationPreprocessorsConfigurer 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<RestTestClientSnippetConfigurer, RestTestClientOperationPreprocessorsConfigurer, RestTestClientRestDocumentationConfigurer>

Returns:

the operation preprocessors configurer

intercept

public ClientHttpResponse intercept(HttpRequest request,
 byte[] body,
 ClientHttpRequestExecution execution)
                             throws IOException

Specified by:

intercept in interface ClientHttpRequestInterceptor

Throws:

IOException