Class MockMvcRestDocumentationConfigurer

java.lang.Object

org.springframework.restdocs.config.RestDocumentationConfigurer<MockMvcSnippetConfigurer, MockMvcOperationPreprocessorsConfigurer, MockMvcRestDocumentationConfigurer>

org.springframework.restdocs.mockmvc.MockMvcRestDocumentationConfigurer

All Implemented Interfaces:

MockMvcConfigurer

public final class MockMvcRestDocumentationConfigurer
extends RestDocumentationConfigurer<MockMvcSnippetConfigurer, MockMvcOperationPreprocessorsConfigurer, MockMvcRestDocumentationConfigurer>
implements MockMvcConfigurer

A MockMvc-specific RestDocumentationConfigurer.

Since:

1.1.0

Author:

Andy Wilkinson, Filip Hrisafov

Method Summary

Modifier and Type	Method	Description
void	afterConfigurerAdded(ConfigurableMockMvcBuilder<?> builder)
RequestPostProcessor	beforeMockMvcCreated(ConfigurableMockMvcBuilder<?> builder, WebApplicationContext context)
MockMvcOperationPreprocessorsConfigurer	operationPreprocessors()	Returns an OperationPreprocessorsConfigurer that can be used to configure the operation request and response preprocessors that will be used.
MockMvcSnippetConfigurer	snippets()	Returns a SnippetConfigurer that can be used to configure the snippets that will be generated.
UriConfigurer	uris()	Returns a UriConfigurer that can be used to configure the request URIs that will be documented.

Methods inherited from class RestDocumentationConfigurer

apply, templateEngine, writerResolver

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

uris

public UriConfigurer uris()

Returns a UriConfigurer that can be used to configure the request URIs that will be documented.

Returns:

the URI configurer

beforeMockMvcCreated

public RequestPostProcessor beforeMockMvcCreated(ConfigurableMockMvcBuilder<?> builder,
 WebApplicationContext context)

Specified by:

beforeMockMvcCreated in interface MockMvcConfigurer

afterConfigurerAdded

public void afterConfigurerAdded(ConfigurableMockMvcBuilder<?> builder)

Specified by:

afterConfigurerAdded in interface MockMvcConfigurer

snippets

public MockMvcSnippetConfigurer 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<MockMvcSnippetConfigurer, MockMvcOperationPreprocessorsConfigurer, MockMvcRestDocumentationConfigurer>

Returns:

the snippet configurer

operationPreprocessors

public MockMvcOperationPreprocessorsConfigurer 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<MockMvcSnippetConfigurer, MockMvcOperationPreprocessorsConfigurer, MockMvcRestDocumentationConfigurer>

Returns:

the operation preprocessors configurer