org.springframework.restdocs.config

Class RestDocumentationConfigurer

java.lang.Object

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

org.springframework.restdocs.config.RestDocumentationConfigurer

All Implemented Interfaces:

MockMvcConfigurer

public class RestDocumentationConfigurer
extends MockMvcConfigurerAdapter

A MockMvcConfigurer that can be used to configure the documentation

Author:

Andy Wilkinson, Dmitriy Mayboroda

See Also:

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

Constructor Summary

Constructors

Constructor and Description
RestDocumentationConfigurer() Creates a new RestDocumentationConfigurer.

Method Summary

Modifier and Type	Method and Description
RequestPostProcessor	beforeMockMvcCreated(ConfigurableMockMvcBuilder<?> builder, WebApplicationContext context)
SnippetConfigurer	snippets()
UriConfigurer	uris()

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

Constructor Detail

RestDocumentationConfigurer

public RestDocumentationConfigurer()

Creates a new RestDocumentationConfigurer.

See Also:

RestDocumentation.documentationConfiguration()

Method Detail

uris

public UriConfigurer uris()

snippets

public SnippetConfigurer snippets()

beforeMockMvcCreated

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

Specified by:

beforeMockMvcCreated in interface MockMvcConfigurer

Overrides:

beforeMockMvcCreated in class MockMvcConfigurerAdapter