org.springframework.restdocs.config

Class SnippetConfigurer<PARENT,TYPE>

java.lang.Object

org.springframework.restdocs.config.AbstractConfigurer

org.springframework.restdocs.config.AbstractNestedConfigurer<PARENT>

org.springframework.restdocs.config.SnippetConfigurer<PARENT,TYPE>

Type Parameters:

PARENT - the type of the configurer's parent

TYPE - the concrete type of the configurer to be returned from chained methods

Direct Known Subclasses:

MockMvcSnippetConfigurer, RestAssuredSnippetConfigurer, WebTestClientSnippetConfigurer

public abstract class SnippetConfigurer<PARENT,TYPE>
extends AbstractNestedConfigurer<PARENT>

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

Since:

1.1.0

Author:

Andy Wilkinson

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SnippetConfigurer(PARENT parent) Creates a new SnippetConfigurer with the given parent.

Method Summary

Modifier and Type	Method and Description
void	apply(Map<String,Object> configuration, RestDocumentationContext context) Applies the configurer to the given configuration.
TYPE	withAdditionalDefaults(Snippet... additionalDefaultSnippets) Configures additional documentation snippets that will be produced by default.
TYPE	withDefaults(Snippet... defaultSnippets) Configures the documentation snippets that will be produced by default.
TYPE	withEncoding(String encoding) Configures any documentation snippets to be written using the given encoding.
TYPE	withTemplateFormat(TemplateFormat format) Configures the format of the documentation snippet templates.

Methods inherited from class org.springframework.restdocs.config.AbstractNestedConfigurer

and

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

DEFAULT_TEMPLATE_FORMAT

public static final TemplateFormat DEFAULT_TEMPLATE_FORMAT

The default format for documentation snippets.

See Also:

withTemplateFormat(TemplateFormat)

Constructor Detail

SnippetConfigurer

protected SnippetConfigurer(PARENT parent)

Creates a new SnippetConfigurer with the given parent.

Parameters:

parent - the parent

Method Detail

apply

public void apply(Map<String,Object> configuration,
                  RestDocumentationContext context)

Description copied from class: AbstractConfigurer

Applies the configurer to the given configuration.

Specified by:

apply in class AbstractConfigurer

Parameters:

configuration - the configuration to be configured

context - the current documentation context

withEncoding

public TYPE 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 TYPE withDefaults(Snippet... defaultSnippets)

Configures the documentation snippets that will be produced by default.

Parameters:

defaultSnippets - the default snippets

Returns:

this

See Also:

withAdditionalDefaults(Snippet...)

withAdditionalDefaults

public TYPE withAdditionalDefaults(Snippet... additionalDefaultSnippets)

Configures additional documentation snippets that will be produced by default.

Parameters:

additionalDefaultSnippets - the additional default snippets

Returns:

this

See Also:

withDefaults(Snippet...)

withTemplateFormat

public TYPE withTemplateFormat(TemplateFormat format)

Configures the format of the documentation snippet templates.

Parameters:

format - the snippet template format

Returns:

this