org.springframework.boot.test.autoconfigure.restdocs

Annotation Type AutoConfigureRestDocs

@Target(value=TYPE)
 @Retention(value=RUNTIME)
 @Documented
 @Inherited
 @ImportAutoConfiguration
 @Import(value=org.springframework.boot.test.autoconfigure.restdocs.RestDocumentationContextProviderRegistrar.class)
 @PropertyMapping(value="spring.test.restdocs")
public @interface AutoConfigureRestDocs

Annotation that can be applied to a test class to enable and configure auto-configuration of Spring REST Docs. The auto-configuration sets up MockMvc-based testing of a servlet web application, WebTestClient-based testing of a reactive web application, or RestAssured-based testing of any web application over HTTP.

Allows configuration of the output directory and the host, scheme, and port of generated URIs. When further configuration is required a RestDocsMockMvcConfigurationCustomizer, RestDocsWebTestClientConfigurationCustomizer, or RestDocsRestAssuredConfigurationCustomizer bean can be used.

Since:

1.4.0

Author:

Andy Wilkinson

See Also:

RestDocsAutoConfiguration, RestDocsMockMvcConfigurationCustomizer, RestDocsWebTestClientConfigurationCustomizer, RestDocsRestAssuredConfigurationCustomizer

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	outputDir The output directory to which generated snippets will be written.
String	uriHost The host to be used in documented URIs.
int	uriPort The port to be used in documented URIs.
String	uriScheme The scheme (typically http or https) to be used in documented URIs.
String	value The output directory to which generated snippets will be written.

Element Detail

value

@AliasFor(value="outputDir")
public abstract String value

The output directory to which generated snippets will be written. An alias for outputDir().

Returns:

the output directory

Default:

""

outputDir

@AliasFor(value="value")
public abstract String outputDir

The output directory to which generated snippets will be written. An alias for value().

Returns:

the output directory

Default:

""

uriScheme

public abstract String uriScheme

The scheme (typically http or https) to be used in documented URIs. Defaults to http.

Returns:

the scheme

Default:

"http"

uriHost

public abstract String uriHost

The host to be used in documented URIs. Defaults to localhost.

Returns:

the host

Default:

"localhost"

uriPort

public abstract int uriPort

The port to be used in documented URIs. Defaults to 8080.

Returns:

the port

Default:

8080