org.springframework.restdocs.mockmvc

Class RestDocumentationMockMvcConfigurer

java.lang.Object

org.springframework.test.web.servlet.setup.MockMvcConfigurerAdapter

org.springframework.restdocs.mockmvc.RestDocumentationMockMvcConfigurer

All Implemented Interfaces:

MockMvcConfigurer

public class RestDocumentationMockMvcConfigurer
extends MockMvcConfigurerAdapter

A MockMvcConfigurer that can be used to configure the documentation

Author:

Andy Wilkinson, Dmitriy Mayboroda

See Also:

ConfigurableMockMvcBuilder.apply(MockMvcConfigurer), MockMvcRestDocumentation.documentationConfiguration(RestDocumentation)

Method Summary

Modifier and Type	Method and Description
RequestPostProcessor	beforeMockMvcCreated(ConfigurableMockMvcBuilder<?> builder, WebApplicationContext context)
SnippetConfigurer	snippets() Returns a SnippetConfigurer that can be used to configure the snippets that will be generated.
RestDocumentationMockMvcConfigurer	templateEngine(TemplateEngine templateEngine) Configures the TemplateEngine that will be used for snippet rendering.
UriConfigurer	uris() Returns a UriConfigurer that can be used to configure the request URIs that will be documented.
RestDocumentationMockMvcConfigurer	writerResolver(WriterResolver writerResolver) Configures the WriterResolver that will be used to resolve a writer for a snippet.

Methods inherited from class org.springframework.test.web.servlet.setup.MockMvcConfigurerAdapter

afterConfigurerAdded

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

snippets

public SnippetConfigurer snippets()

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

Returns:

the snippet configurer

templateEngine

public RestDocumentationMockMvcConfigurer templateEngine(TemplateEngine templateEngine)

Configures the TemplateEngine that will be used for snippet rendering.

Parameters:

templateEngine - the template engine to use

Returns:

this

writerResolver

public RestDocumentationMockMvcConfigurer writerResolver(WriterResolver writerResolver)

Configures the WriterResolver that will be used to resolve a writer for a snippet.

Parameters:

writerResolver - The writer resolver to use

Returns:

this

beforeMockMvcCreated

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

Specified by:

beforeMockMvcCreated in interface MockMvcConfigurer

Overrides:

beforeMockMvcCreated in class MockMvcConfigurerAdapter