org.springframework.web.reactive.function.client

Interface WebClient

public interface WebClient

A non-blocking, reactive client for performing HTTP requests with Reactive Streams back pressure. Provides a higher level, common API over HTTP client libraries. Reactor Netty is used by default but other clients may be plugged in with a ClientHttpConnector.

Use one of the static factory methods create() or create(String) or obtain a builder() to create an instance.

For examples with a response body see retrieve() and exchange(). For examples with a request body see body(Publisher,Class), syncBody(Object), and body(BodyInserter).

Since:

5.0

Author:

Rossen Stoyanchev, Arjen Poutsma

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	WebClient.Builder A mutable builder for creating a WebClient.
static interface	WebClient.RequestBodySpec
static interface	WebClient.RequestBodyUriSpec
static interface	WebClient.RequestHeadersSpec<S extends WebClient.RequestHeadersSpec<S>> Contract for specifying request headers leading up to the exchange.
static interface	WebClient.RequestHeadersUriSpec<S extends WebClient.RequestHeadersSpec<S>>
static interface	WebClient.ResponseSpec
static interface	WebClient.UriSpec<S extends WebClient.RequestHeadersSpec<?>> Contract for specifying the URI for a request.

Method Summary

Modifier and Type	Method and Description
static WebClient.Builder	builder() Obtain a WebClient builder.
static WebClient	create() Create a new WebClient with a Reactor Netty connector.
static WebClient	create(java.lang.String baseUrl) A variant of create() that accepts a default base URL.
WebClient.RequestHeadersUriSpec<?>	delete() Prepare an HTTP DELETE request.
WebClient.RequestHeadersUriSpec<?>	get() Prepare an HTTP GET request.
WebClient.RequestHeadersUriSpec<?>	head() Prepare an HTTP HEAD request.
WebClient.RequestBodyUriSpec	method(HttpMethod method) Prepare a request for the specified HttpMethod.
WebClient.Builder	mutate() Return a builder to mutate properties of this web client.
WebClient.RequestHeadersUriSpec<?>	options() Prepare an HTTP OPTIONS request.
WebClient.RequestBodyUriSpec	patch() Prepare an HTTP PATCH request.
WebClient.RequestBodyUriSpec	post() Prepare an HTTP POST request.
WebClient.RequestBodyUriSpec	put() Prepare an HTTP PUT request.

Method Detail

get

WebClient.RequestHeadersUriSpec<?> get()

Prepare an HTTP GET request.

Returns:

a spec for specifying the target URL

head

WebClient.RequestHeadersUriSpec<?> head()

Prepare an HTTP HEAD request.

Returns:

a spec for specifying the target URL

post

WebClient.RequestBodyUriSpec post()

Prepare an HTTP POST request.

Returns:

a spec for specifying the target URL

put

WebClient.RequestBodyUriSpec put()

Prepare an HTTP PUT request.

Returns:

a spec for specifying the target URL

patch

WebClient.RequestBodyUriSpec patch()

Prepare an HTTP PATCH request.

Returns:

a spec for specifying the target URL

delete

WebClient.RequestHeadersUriSpec<?> delete()

Prepare an HTTP DELETE request.

Returns:

a spec for specifying the target URL

options

WebClient.RequestHeadersUriSpec<?> options()

Prepare an HTTP OPTIONS request.

Returns:

a spec for specifying the target URL

method

WebClient.RequestBodyUriSpec method(HttpMethod method)

Prepare a request for the specified HttpMethod.

Returns:

a spec for specifying the target URL

mutate

WebClient.Builder mutate()

Return a builder to mutate properties of this web client.

create

static WebClient create()

Create a new WebClient with a Reactor Netty connector.

See Also:

create(String), builder()

create

static WebClient create(java.lang.String baseUrl)

A variant of create() that accepts a default base URL. For more details see Builder.baseUrl(String).

Parameters:

baseUrl - the base URI for all requests

builder

static WebClient.Builder builder()

Obtain a WebClient builder.