org.springframework.test.web.reactive.server

Interface WebTestClient

All Known Implementing Classes:

DefaultWebTestClient

public interface WebTestClient

Main entry point for testing WebFlux server endpoints with an API similar to that of WebClient, and actually delegating to a WebClient instance, but with a focus on testing.

The WebTestClient has 3 setup options without a running server:

• bindToController(java.lang.Object...)
• bindToApplicationContext(org.springframework.context.ApplicationContext)
• bindToRouterFunction(org.springframework.web.reactive.function.server.RouterFunction<?>)

and 1 option for actual requests on a socket:

• bindToServer()

Since:

5.0

Author:

Rossen Stoyanchev

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	WebTestClient.BodySpec Specification to apply additional assertions on the response body.
static interface	WebTestClient.Builder Steps for customizing the WebClient used to test with internally delegating to a WebClient.Builder.
static interface	WebTestClient.ControllerSpec Specification for customizing controller configuration equivalent to, and internally delegating to, a WebFluxConfigurer.
static interface	WebTestClient.HeaderSpec Specification for adding request headers and performing an exchange.
static interface	WebTestClient.ListBodySpec Specification to assert a list of values extracted from the response.
static interface	WebTestClient.MapBodySpec Specification to assert response the body extracted as a map.
static interface	WebTestClient.ResponseSpec Specification for processing the response and applying expectations.
static interface	WebTestClient.SingleValueBodySpec Specification to assert a single value extracted from the response body.
static interface	WebTestClient.TypeBodySpec Specification for extracting entities from the response body.
static interface	WebTestClient.UriSpec Specification for providing the URI of a request.

Method Summary

Modifier and Type	Method and Description
static WebTestClient.Builder	bindToApplicationContext(ApplicationContext applicationContext) Integration testing without a server, with WebFlux infrastructure detected from an ApplicationContext such as @EnableWebFlux Java config and annotated controller Spring beans.
static WebTestClient.ControllerSpec	bindToController(java.lang.Object... controllers) Integration testing without a server, targeting specific annotated, WebFlux controllers.
static WebTestClient.Builder	bindToRouterFunction(RouterFunction<?> routerFunction) Integration testing without a server, targeting WebFlux functional endpoints.
static WebTestClient.Builder	bindToServer() Complete end-to-end integration tests with actual requests to a running server.
WebTestClient.UriSpec	delete() Prepare an HTTP DELETE request.
WebTestClient	filter(ExchangeFilterFunction filterFunction) Filter the client with the given ExchangeFilterFunction.
WebTestClient.UriSpec	get() Prepare an HTTP GET request.
WebTestClient.UriSpec	head() Prepare an HTTP HEAD request.
WebTestClient.UriSpec	options() Prepare an HTTP OPTIONS request.
WebTestClient.UriSpec	patch() Prepare an HTTP PATCH request.
WebTestClient.UriSpec	post() Prepare an HTTP POST request.
WebTestClient.UriSpec	put() Prepare an HTTP PUT request.

Method Detail

get

WebTestClient.UriSpec get()

Prepare an HTTP GET request.

Returns:

a spec for specifying the target URL

head

WebTestClient.UriSpec head()

Prepare an HTTP HEAD request.

Returns:

a spec for specifying the target URL

post

WebTestClient.UriSpec post()

Prepare an HTTP POST request.

Returns:

a spec for specifying the target URL

put

WebTestClient.UriSpec put()

Prepare an HTTP PUT request.

Returns:

a spec for specifying the target URL

patch

WebTestClient.UriSpec patch()

Prepare an HTTP PATCH request.

Returns:

a spec for specifying the target URL

delete

WebTestClient.UriSpec delete()

Prepare an HTTP DELETE request.

Returns:

a spec for specifying the target URL

options

WebTestClient.UriSpec options()

Prepare an HTTP OPTIONS request.

Returns:

a spec for specifying the target URL

filter

WebTestClient filter(ExchangeFilterFunction filterFunction)

Filter the client with the given ExchangeFilterFunction.

Parameters:

filterFunction - the filter to apply to this client

Returns:

the filtered client

See Also:

ExchangeFilterFunction.apply(ExchangeFunction)

bindToController

static WebTestClient.ControllerSpec bindToController(java.lang.Object... controllers)

Integration testing without a server, targeting specific annotated, WebFlux controllers. The default configuration is the same as for @EnableWebFlux but can also be further customized through the returned spec.

Parameters:

controllers - the controllers to test

Returns:

spec for setting up controller configuration

bindToApplicationContext

static WebTestClient.Builder bindToApplicationContext(ApplicationContext applicationContext)

Integration testing without a server, with WebFlux infrastructure detected from an ApplicationContext such as @EnableWebFlux Java config and annotated controller Spring beans.

Parameters:

applicationContext - the context

Returns:

the WebTestClient builder

See Also:

EnableWebFlux

bindToRouterFunction

static WebTestClient.Builder bindToRouterFunction(RouterFunction<?> routerFunction)

Integration testing without a server, targeting WebFlux functional endpoints.

Parameters:

routerFunction - the RouterFunction to test

Returns:

the WebTestClient builder

bindToServer

static WebTestClient.Builder bindToServer()

Complete end-to-end integration tests with actual requests to a running server.

Returns:

the WebTestClient builder