spring-framework/framework-docs/modules/ROOT/pages/web/webmvc-client.adoc

[[webmvc-client]]
= REST Clients

This section describes options for client-side access to REST endpoints.


[[webmvc-resttemplate]]
== `RestTemplate`

`RestTemplate` is a synchronous client to perform HTTP requests. It is the original
Spring REST client and exposes a simple, template-method API over underlying HTTP client
libraries.

NOTE: As of 5.0 the `RestTemplate` is in maintenance mode, with only requests for minor
changes and bugs to be accepted. Please, consider using the
xref:web/webflux-webclient.adoc[WebClient] which offers a more modern API and
supports sync, async, and streaming scenarios.

See xref:integration/rest-clients.adoc[REST Endpoints] for details.


[[webmvc-webclient]]
== `WebClient`

`WebClient` is a non-blocking, reactive client to perform HTTP requests. It was
introduced in 5.0 and offers a modern alternative to the `RestTemplate`, with efficient
support for both synchronous and asynchronous, as well as streaming scenarios.

In contrast to `RestTemplate`, `WebClient` supports the following:

* Non-blocking I/O.
* Reactive Streams back pressure.
* High concurrency with fewer hardware resources.
* Functional-style, fluent API that takes advantage of Java 8 lambdas.
* Synchronous and asynchronous interactions.
* Streaming up to or streaming down from a server.

See xref:web/webflux-webclient.adoc[WebClient] for more details.


[[webmvc-http-interface]]
== HTTP Interface

The Spring Frameworks lets you define an HTTP service as a Java interface with HTTP
exchange methods. You can then generate a proxy that implements this interface and
performs the exchanges. This helps to simplify HTTP remote access and provides additional
flexibility for to choose an API style such as synchronous or reactive.

See xref:integration/rest-clients.adoc#rest-http-interface[REST Endpoints] for details.
Summary of client-side REST options in MVC section 2017-10-14 01:24:33 +08:00			`[[webmvc-client]]`
			`= REST Clients`

			`This section describes options for client-side access to REST endpoints.`

Consistent separation between chapters and after chapter titles 2017-10-19 02:24:17 +08:00

Asciidoc revision (chapter declarations, javadoc references, etc) 2018-10-25 21:15:58 +08:00
Summary of client-side REST options in MVC section 2017-10-14 01:24:33 +08:00			`[[webmvc-resttemplate]]`
Restore sub-section headings in web content Headings are optimized for how they appear in the left-hand side navitation menu, with context provided by parent headings, and not necessarily for how they read on their own. At 2nd and 3rd level of nesting, which is where most headings are, the wrapping becomes too distracting and the left-hand side navigation sprawling. 2018-10-06 03:54:38 +08:00			== `RestTemplate`
Summary of client-side REST options in MVC section 2017-10-14 01:24:33 +08:00
Add notes on future deprecation of the RestTemplate Issue: SPR-16993 2018-07-27 20:32:59 +08:00			`RestTemplate` is a synchronous client to perform HTTP requests. It is the original
Edit the Web chapter of the reference documentation I edited for spelling, punctuation, grammar, usage, and corporate voice. I also added links and cross-references. 2018-09-17 22:36:43 +08:00			`Spring REST client and exposes a simple, template-method API over underlying HTTP client`
Add notes on future deprecation of the RestTemplate Issue: SPR-16993 2018-07-27 20:32:59 +08:00			`libraries.`
Summary of client-side REST options in MVC section 2017-10-14 01:24:33 +08:00
Add documentation for interface proxy client Closes gh-28386 2022-05-09 16:49:28 +08:00			NOTE: As of 5.0 the `RestTemplate` is in maintenance mode, with only requests for minor
			`changes and bugs to be accepted. Please, consider using the`
Fix cross references 2023-04-19 23:26:17 +08:00			`xref:web/webflux-webclient.adoc[WebClient] which offers a more modern API and`
Update advice on RestTemplate Closes gh-24503 2020-02-11 22:01:21 +08:00			`supports sync, async, and streaming scenarios.`
Summary of client-side REST options in MVC section 2017-10-14 01:24:33 +08:00
Fix cross references 2023-04-19 23:26:17 +08:00			`See xref:integration/rest-clients.adoc[REST Endpoints] for details.`
Summary of client-side REST options in MVC section 2017-10-14 01:24:33 +08:00
Consistent separation between chapters and after chapter titles 2017-10-19 02:24:17 +08:00

Asciidoc revision (chapter declarations, javadoc references, etc) 2018-10-25 21:15:58 +08:00
Summary of client-side REST options in MVC section 2017-10-14 01:24:33 +08:00			`[[webmvc-webclient]]`
Restore sub-section headings in web content Headings are optimized for how they appear in the left-hand side navitation menu, with context provided by parent headings, and not necessarily for how they read on their own. At 2nd and 3rd level of nesting, which is where most headings are, the wrapping becomes too distracting and the left-hand side navigation sprawling. 2018-10-06 03:54:38 +08:00			== `WebClient`
Summary of client-side REST options in MVC section 2017-10-14 01:24:33 +08:00
Add notes on future deprecation of the RestTemplate Issue: SPR-16993 2018-07-27 20:32:59 +08:00			`WebClient` is a non-blocking, reactive client to perform HTTP requests. It was
Edit the Web chapter of the reference documentation I edited for spelling, punctuation, grammar, usage, and corporate voice. I also added links and cross-references. 2018-09-17 22:36:43 +08:00			introduced in 5.0 and offers a modern alternative to the `RestTemplate`, with efficient
Add notes on future deprecation of the RestTemplate Issue: SPR-16993 2018-07-27 20:32:59 +08:00			`support for both synchronous and asynchronous, as well as streaming scenarios.`
Summary of client-side REST options in MVC section 2017-10-14 01:24:33 +08:00
Edit the Web chapter of the reference documentation I edited for spelling, punctuation, grammar, usage, and corporate voice. I also added links and cross-references. 2018-09-17 22:36:43 +08:00			In contrast to `RestTemplate`, `WebClient` supports the following:
Update section in reference on WebClient Rename "Builder" sub-section to "Configuration" and move it in the beginning before all others since it explains how to create a client in the first place. Update content on Reactor Netty connector based on the API in 0.8 and specifically address Reactor Netty resources and lifecycle. Issue: SPR-16963 2018-08-14 20:48:14 +08:00
			`* Non-blocking I/O.`
			`* Reactive Streams back pressure.`
Edit the Web chapter of the reference documentation I edited for spelling, punctuation, grammar, usage, and corporate voice. I also added links and cross-references. 2018-09-17 22:36:43 +08:00			`* High concurrency with fewer hardware resources.`
			`* Functional-style, fluent API that takes advantage of Java 8 lambdas.`
Update section in reference on WebClient Rename "Builder" sub-section to "Configuration" and move it in the beginning before all others since it explains how to create a client in the first place. Update content on Reactor Netty connector based on the API in 0.8 and specifically address Reactor Netty resources and lifecycle. Issue: SPR-16963 2018-08-14 20:48:14 +08:00			`* Synchronous and asynchronous interactions.`
			`* Streaming up to or streaming down from a server.`

Fix cross references 2023-04-19 23:26:17 +08:00			`See xref:web/webflux-webclient.adoc[WebClient] for more details.`
Add documentation for interface proxy client Closes gh-28386 2022-05-09 16:49:28 +08:00



			`[[webmvc-http-interface]]`
			`== HTTP Interface`

			`The Spring Frameworks lets you define an HTTP service as a Java interface with HTTP`
			`exchange methods. You can then generate a proxy that implements this interface and`
			`performs the exchanges. This helps to simplify HTTP remote access and provides additional`
			`flexibility for to choose an API style such as synchronous or reactive.`

Fix cross references 2023-04-19 23:26:17 +08:00			`See xref:integration/rest-clients.adoc#rest-http-interface[REST Endpoints] for details.`