Class UriConfigurer

java.lang.Object

org.springframework.restdocs.config.AbstractConfigurer

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

org.springframework.restdocs.mockmvc.UriConfigurer

All Implemented Interfaces:

MockMvcConfigurer

public class UriConfigurer
extends AbstractNestedConfigurer<MockMvcRestDocumentationConfigurer>
implements MockMvcConfigurer

A configurer that can be used to configure the documented URIs.

Author:

Andy Wilkinson

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_HOST	The defalt host for documented URIs.
static final int	DEFAULT_PORT	The default port for documented URIs.
static final String	DEFAULT_SCHEME	The default scheme for documented URIs.

Method Summary

Modifier and Type	Method	Description
void	afterConfigurerAdded(ConfigurableMockMvcBuilder<?> builder)
void	apply(Map<String,Object> configuration, RestDocumentationContext context)	Applies the configurer to the given configuration.
RequestPostProcessor	beforeMockMvcCreated(ConfigurableMockMvcBuilder<?> builder, WebApplicationContext context)
UriConfigurer	withHost(String host)	Configures any documented URIs to use the given host.
UriConfigurer	withPort(int port)	Configures any documented URIs to use the given port.
UriConfigurer	withScheme(String scheme)	Configures any documented URIs to use the given scheme.

Methods inherited from class AbstractNestedConfigurer

and

Methods inherited from class Object

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

Field Details

DEFAULT_SCHEME

public static final String DEFAULT_SCHEME

The default scheme for documented URIs.

See Also:

• withScheme(String)
• Constant Field Values

DEFAULT_HOST

public static final String DEFAULT_HOST

The defalt host for documented URIs.

See Also:

• withHost(String)
• Constant Field Values

DEFAULT_PORT

public static final int DEFAULT_PORT

The default port for documented URIs.

See Also:

• withPort(int)
• Constant Field Values

Method Details

withScheme

public UriConfigurer withScheme(String scheme)

Configures any documented URIs to use the given scheme. The default is http.

Parameters:

scheme - the URI scheme

Returns:

this

withHost

public UriConfigurer withHost(String host)

Configures any documented URIs to use the given host. The default is localhost.

Parameters:

host - the URI host

Returns:

this

withPort

public UriConfigurer withPort(int port)

Configures any documented URIs to use the given port. The default is 8080.

Parameters:

port - the URI port

Returns:

this

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

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