org.springframework.restdocs.mockmvc

Class MockMvcRestDocumentationConfigurer

java.lang.Object

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

org.springframework.restdocs.mockmvc.MockMvcRestDocumentationConfigurer

All Implemented Interfaces:

org.springframework.test.web.servlet.setup.MockMvcConfigurer

public final class MockMvcRestDocumentationConfigurer
extends RestDocumentationConfigurer<MockMvcSnippetConfigurer,MockMvcOperationPreprocessorsConfigurer,MockMvcRestDocumentationConfigurer>
implements org.springframework.test.web.servlet.setup.MockMvcConfigurer

A MockMvc-specific RestDocumentationConfigurer.

Since:

1.1.0

Author:

Andy Wilkinson, Filip Hrisafov

Method Summary

Modifier and Type	Method and Description
void	afterConfigurerAdded(org.springframework.test.web.servlet.setup.ConfigurableMockMvcBuilder<?> builder)
org.springframework.test.web.servlet.request.RequestPostProcessor	beforeMockMvcCreated(org.springframework.test.web.servlet.setup.ConfigurableMockMvcBuilder<?> builder, org.springframework.web.context.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 org.springframework.restdocs.config.RestDocumentationConfigurer

apply, templateEngine, writerResolver

Methods inherited from class java.lang.Object

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

Method Detail

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 org.springframework.test.web.servlet.request.RequestPostProcessor beforeMockMvcCreated(org.springframework.test.web.servlet.setup.ConfigurableMockMvcBuilder<?> builder,
                                                                                              org.springframework.web.context.WebApplicationContext context)

Specified by:

beforeMockMvcCreated in interface org.springframework.test.web.servlet.setup.MockMvcConfigurer

afterConfigurerAdded

public void afterConfigurerAdded(org.springframework.test.web.servlet.setup.ConfigurableMockMvcBuilder<?> builder)

Specified by:

afterConfigurerAdded in interface org.springframework.test.web.servlet.setup.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