Interface WebTestClient.ControllerSpec

All Superinterfaces:

WebTestClient.MockServerSpec<WebTestClient.ControllerSpec>

Enclosing interface:

WebTestClient

public static interface WebTestClient.ControllerSpec
extends WebTestClient.MockServerSpec<WebTestClient.ControllerSpec>

Specification for customizing controller configuration equivalent to, and internally delegating to, a WebFluxConfigurer.

Since:

5.0

Author:

Rossen Stoyanchev, Brian Clozel, Sam Brannen, Michał Rowicki

Method Summary

Modifier and Type	Method	Description
WebTestClient.ControllerSpec	apiVersioning(Consumer<ApiVersionConfigurer> configurer)	Configure API versioning for mapping requests to controller methods.
WebTestClient.ControllerSpec	argumentResolvers(Consumer<ArgumentResolverConfigurer> configurer)	Configure resolvers for custom controller method arguments.
WebTestClient.ControllerSpec	blockingExecution(Consumer<BlockingExecutionConfigurer> consumer)	Configure blocking execution options.
WebTestClient.ControllerSpec	contentTypeResolver(Consumer<RequestedContentTypeResolverBuilder> consumer)	Customize content type resolution.
WebTestClient.ControllerSpec	controllerAdvice(Object... controllerAdvice)	Register one or more ControllerAdvice instances to be used in tests (specified Class will be turned into instance).
WebTestClient.ControllerSpec	corsMappings(Consumer<CorsRegistry> consumer)	Configure CORS support.
WebTestClient.ControllerSpec	formatters(Consumer<FormatterRegistry> consumer)	Register formatters and converters to use for type conversion.
WebTestClient.ControllerSpec	httpMessageCodecs(Consumer<ServerCodecConfigurer> configurer)	Configure custom HTTP message readers and writers or override built-in ones.
WebTestClient.ControllerSpec	pathMatching(Consumer<PathMatchConfigurer> consumer)	Configure path matching options.
WebTestClient.ControllerSpec	validator(Validator validator)	Configure a global Validator.
WebTestClient.ControllerSpec	viewResolvers(Consumer<ViewResolverRegistry> consumer)	Configure view resolution.

Methods inherited from interface org.springframework.test.web.reactive.server.WebTestClient.MockServerSpec

apply, build, configureClient, sslInfo, webFilter, webSessionManager

Method Details

controllerAdvice

WebTestClient.ControllerSpec controllerAdvice(Object... controllerAdvice)

Register one or more ControllerAdvice instances to be used in tests (specified Class will be turned into instance).

contentTypeResolver

WebTestClient.ControllerSpec contentTypeResolver(Consumer<RequestedContentTypeResolverBuilder> consumer)

Customize content type resolution.

See Also:

• WebFluxConfigurer.configureContentTypeResolver(org.springframework.web.reactive.accept.RequestedContentTypeResolverBuilder)

corsMappings

WebTestClient.ControllerSpec corsMappings(Consumer<CorsRegistry> consumer)

Configure CORS support.

See Also:

• WebFluxConfigurer.addCorsMappings(org.springframework.web.reactive.config.CorsRegistry)

pathMatching

WebTestClient.ControllerSpec pathMatching(Consumer<PathMatchConfigurer> consumer)

Configure path matching options.

See Also:

• WebFluxConfigurer.configurePathMatching(org.springframework.web.reactive.config.PathMatchConfigurer)

argumentResolvers

WebTestClient.ControllerSpec argumentResolvers(Consumer<ArgumentResolverConfigurer> configurer)

Configure resolvers for custom controller method arguments.

See Also:

• WebFluxConfigurer.configureHttpMessageCodecs(org.springframework.http.codec.ServerCodecConfigurer)

httpMessageCodecs

WebTestClient.ControllerSpec httpMessageCodecs(Consumer<ServerCodecConfigurer> configurer)

Configure custom HTTP message readers and writers or override built-in ones.

See Also:

• WebFluxConfigurer.configureHttpMessageCodecs(org.springframework.http.codec.ServerCodecConfigurer)

formatters

WebTestClient.ControllerSpec formatters(Consumer<FormatterRegistry> consumer)

Register formatters and converters to use for type conversion.

See Also:

• WebFluxConfigurer.addFormatters(org.springframework.format.FormatterRegistry)

validator

WebTestClient.ControllerSpec validator(Validator validator)

Configure a global Validator.

See Also:

• WebFluxConfigurer.getValidator()

apiVersioning

WebTestClient.ControllerSpec apiVersioning(Consumer<ApiVersionConfigurer> configurer)

Configure API versioning for mapping requests to controller methods.

Since:

7.0

viewResolvers

WebTestClient.ControllerSpec viewResolvers(Consumer<ViewResolverRegistry> consumer)

Configure view resolution.

See Also:

• WebFluxConfigurer.configureViewResolvers(org.springframework.web.reactive.config.ViewResolverRegistry)

blockingExecution

WebTestClient.ControllerSpec blockingExecution(Consumer<BlockingExecutionConfigurer> consumer)

Configure blocking execution options.

Since:

6.1

See Also:

• WebFluxConfigurer.configureBlockingExecution(org.springframework.web.reactive.config.BlockingExecutionConfigurer)