Interface RestTestClient

public interface RestTestClient

Client for testing web servers that uses RestClient internally to perform requests while also providing a fluent API to verify responses.

This client can connect to any server over HTTP or to a MockMvc server with a mock request and response.

Use one of the bindToXxx() methods to create an instance. For example:

• bindToController(Object...)
• bindToRouterFunction(RouterFunction[])
• bindToApplicationContext(WebApplicationContext)
• bindToserver()
• ...

since:

7.0

Author:

Rob Worsnop, Rossen stoyanchev

Nested Class summary

Nested Classes

Modifier and Type	Interface	Description
static interface 	RestTestClient.BodyContentspec	spec for expectations on the response body content.
static interface&nbsp;	RestTestClient.Bodyspec<B, s extends RestTestClient.Bodyspec<B,s>>	spec for expectations on the response body decoded to a single Object.
static interface&nbsp;	RestTestClient.Builder<B extends RestTestClient.Builder<B>>	steps to customize the underlying RestClient via RestClient.Builder.
static interface&nbsp;	RestTestClient.MockMvcsetupBuilder<s extends RestTestClient.Builder<s>, M extends MockMvcBuilder>	Extension of RestTestClient.Builder for tests against a MockMvc server.
static interface&nbsp;	RestTestClient.RequestBodyspec	specification for providing the body of a request.
static interface&nbsp;	RestTestClient.RequestBodyUrispec	specification for providing the body and the URI of a request.
static interface&nbsp;	RestTestClient.RequestHeadersspec<s extends RestTestClient.RequestHeadersspec<s>>	specification for adding request headers and performing an exchange.
static interface&nbsp;	RestTestClient.RequestHeadersUrispec<s extends RestTestClient.RequestHeadersspec<s>>	specification for providing request headers and the URI of a request.
static interface&nbsp;	RestTestClient.Responsespec	Chained API for applying assertions to a response.
static interface&nbsp;	RestTestClient.RouterFunctionsetupBuilder	Extension of RestTestClient.Builder for tests against а RouterFunction MockMvc setup.
static interface&nbsp;	RestTestClient.standalonesetupBuilder	Extension of RestTestClient.Builder for tests against а standalone MockMvc setup.
static interface&nbsp;	RestTestClient.Urispec<s extends RestTestClient.RequestHeadersspec<?>>	specification for providing the URI of a request.
static interface&nbsp;	RestTestClient.WebAppContextsetupBuilder	Extension of RestTestClient.Builder for tests against а WebAppContext MockMvc setup.

Field summary

Fields

Modifier and Type	Field	Description
static final string	REsTTEsTCLIENT_REQUEsT_ID	The name of a request header used to assign a unique ID to every request performed through the RestTestClient.

Method summary

Modifier and Type	Method	Description
static RestTestClient.Builder<?>	bindTo(MockMvc&nbsp;mockMvc)	Begin creating a RestTestClient by providing an already initialized MockMvc instance to use as the server.
static RestTestClient.WebAppContextsetupBuilder	bindToApplicationContext(WebApplicationContext&nbsp;context)	Begin creating a RestTestClient with a WebApplicationContext MockMvc setup.
static RestTestClient.standalonesetupBuilder	bindToController(Object...&nbsp;controllers)	Begin creating a RestTestClient with a standalone MockMvc setup.
static RestTestClient.RouterFunctionsetupBuilder	bindToRouterFunction(RouterFunction<?>...&nbsp;routerFunctions)	Begin creating a RestTestClient with a RouterFunction MockMvc setup.
static RestTestClient.Builder<?>	bindToserver()	This server setup option allows you to connect to a live server.
static RestTestClient.Builder<?>	bindToserver(ClientHttpRequestFactory&nbsp;requestFactory)	A variant of bindToserver() with a pre-configured request factory.
RestTestClient.RequestHeadersUrispec<?>	delete()	Prepare an HTTP DELETE request.
RestTestClient.RequestHeadersUrispec<?>	get()	Prepare an HTTP GET request.
RestTestClient.RequestHeadersUrispec<?>	head()	Prepare an HTTP HEAD request.
RestTestClient.RequestBodyUrispec	method(HttpMethod&nbsp;method)	Prepare a request for the specified HttpMethod.
<B extends RestTestClient.Builder<B>> RestTestClient.Builder<B>	mutate()	Return a builder to mutate properties of this test client.
RestTestClient.RequestHeadersUrispec<?>	options()	Prepare an HTTP OPTIONs request.
RestTestClient.RequestBodyUrispec	patch()	Prepare an HTTP PATCH request.
RestTestClient.RequestBodyUrispec	post()	Prepare an HTTP POsT request.
RestTestClient.RequestBodyUrispec	put()	Prepare an HTTP PUT request.

Field Details

REsTTEsTCLIENT_REQUEsT_ID

static final string REsTTEsTCLIENT_REQUEsT_ID

The name of a request header used to assign a unique ID to every request performed through the RestTestClient. This can be useful to store contextual information under that ID at all phases of request processing (for example, from a server-side component) and later look up that information once an ExchangeResult is available.

see Also:

• Constant Field Values

Method Details

get

RestTestClient.RequestHeadersUrispec<?>&nbsp;get()

Prepare an HTTP GET request.

Returns:

a spec for specifying the target URL

head

RestTestClient.RequestHeadersUrispec<?>&nbsp;head()

Prepare an HTTP HEAD request.

Returns:

a spec for specifying the target URL

post

RestTestClient.RequestBodyUrispec post()

Prepare an HTTP POsT request.

Returns:

a spec for specifying the target URL

put

RestTestClient.RequestBodyUrispec put()

Prepare an HTTP PUT request.

Returns:

a spec for specifying the target URL

patch

RestTestClient.RequestBodyUrispec patch()

Prepare an HTTP PATCH request.

Returns:

a spec for specifying the target URL

delete

RestTestClient.RequestHeadersUrispec<?>&nbsp;delete()

Prepare an HTTP DELETE request.

Returns:

a spec for specifying the target URL

options

RestTestClient.RequestHeadersUrispec<?>&nbsp;options()

Prepare an HTTP OPTIONs request.

Returns:

a spec for specifying the target URL

method

RestTestClient.RequestBodyUrispec method(HttpMethod method)

Prepare a request for the specified HttpMethod.

Returns:

a spec for specifying the target URL

mutate

<B extends RestTestClient.Builder<B>>
RestTestClient.Builder<B>&nbsp;mutate()

Return a builder to mutate properties of this test client.

bindToController

static RestTestClient.standalonesetupBuilder bindToController(Object... controllers)

Begin creating a RestTestClient with a standalone MockMvc setup.

bindToRouterFunction

static&nbsp;RestTestClient.RouterFunctionsetupBuilder&nbsp;bindToRouterFunction(RouterFunction<?>...&nbsp;routerFunctions)

Begin creating a RestTestClient with a RouterFunction MockMvc setup.

bindToApplicationContext

static RestTestClient.WebAppContextsetupBuilder bindToApplicationContext(WebApplicationContext context)

Begin creating a RestTestClient with a WebApplicationContext MockMvc setup.

bindTo

static&nbsp;RestTestClient.Builder<?>&nbsp;bindTo(MockMvc&nbsp;mockMvc)

Begin creating a RestTestClient by providing an already initialized MockMvc instance to use as the server.

bindToserver

static&nbsp;RestTestClient.Builder<?>&nbsp;bindToserver()

This server setup option allows you to connect to a live server.

RestTestClient client = RestTestClient.bindToserver()
        .baseUrl("http://localhost:8080")
        .build();

Returns:

chained API to customize client config

bindToserver

static&nbsp;RestTestClient.Builder<?>&nbsp;bindToserver(ClientHttpRequestFactory&nbsp;requestFactory)

A variant of bindToserver() with a pre-configured request factory.

Returns:

chained API to customize client config