org.springframework.restdocs.mockmvc

Class SnippetConfigurer

java.lang.Object

org.springframework.restdocs.mockmvc.SnippetConfigurer

All Implemented Interfaces:

MockMvcConfigurer

public class SnippetConfigurer
extends Object

A configurer that can be used to configure the generated documentation snippets.

Author:

Andy Wilkinson

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_SNIPPET_ENCODING The default encoding for documentation snippets.

Method Summary

Modifier and Type	Method and Description
void	afterConfigurerAdded(ConfigurableMockMvcBuilder<?> builder)
PARENT	and() Returns the configurer's parent.
RequestPostProcessor	beforeMockMvcCreated(ConfigurableMockMvcBuilder<?> builder, WebApplicationContext context)
SnippetConfigurer	withDefaults(Snippet... defaultSnippets) Configures the documentation snippets that will be produced by default.
SnippetConfigurer	withEncoding(String encoding) Configures any documentation snippets to be written using the given encoding.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_SNIPPET_ENCODING

public static final String DEFAULT_SNIPPET_ENCODING

The default encoding for documentation snippets.

See Also:

withEncoding(String), Constant Field Values

Method Detail

withEncoding

public SnippetConfigurer withEncoding(String encoding)

Configures any documentation snippets to be written using the given encoding. The default is UTF-8.

Parameters:

encoding - the encoding

Returns:

this

withDefaults

public SnippetConfigurer withDefaults(Snippet... defaultSnippets)

Configures the documentation snippets that will be produced by default.

Parameters:

defaultSnippets - the default snippets

Returns:

this

and

public PARENT and()

Returns the configurer's parent.

Returns:

the parent

afterConfigurerAdded

public void afterConfigurerAdded(ConfigurableMockMvcBuilder<?> builder)

Specified by:

afterConfigurerAdded in interface MockMvcConfigurer

beforeMockMvcCreated

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

Specified by:

beforeMockMvcCreated in interface MockMvcConfigurer