Spring/spring-framework
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

WebFlux and Integration share webflux-client.adoc

Browse Source 
Extract WebClient content into a separate file that is now included
both in the WebFlux and in the Integration sections.

This allows having RestTemplate and WebClient documented in one place
under Integration while also keeping the same included in the WebFlux
section too.
This commit is contained in:
Rossen Stoyanchev
2017-09-27 23:34:45 -04:00
parent 71ccf3c9e3
commit 67910ee48c
3 changed files with 274 additions and 296 deletions
Download Patch File Download Diff File Expand all files Collapse all files

50
src/docs/asciidoc/integration.adoc
View File

@@ -946,50 +946,24 @@ plugging in third-party or custom solutions here.
[[rest-client-access]]
=== Accessing RESTful services on the Client
The `RestTemplate` is the core class for client-side access to RESTful services. It is
conceptually similar to other template classes in Spring, such as `JdbcTemplate` and
`JmsTemplate` and other template classes found in other Spring portfolio projects.
`RestTemplate`'s behavior is customized by providing callback methods and configuring
the `HttpMessageConverter` used to marshal objects into the HTTP request body and to
unmarshal any response back into an object. As it is common to use XML as a message
format, Spring provides a `MarshallingHttpMessageConverter` that uses the Object-to-XML
framework that is part of the `org.springframework.oxm` package. This gives you a wide
range of choices of XML to Object mapping technologies to choose from.
=== Accessing REST endpoints
This section describes how to use the `RestTemplate` and its associated
`HttpMessageConverters`.
The Spring Framework offers two choices for client-side access to REST endpoints:
* <<rest-resttemplate>> -- the original Spring REST client with an API similar to other
template classes in Spring, such as `JdbcTemplate`, `JmsTemplate` and others. The
`RestTemplate` is built for synchronous use with the blocking I/O.
* <<webflux-client,WebClient>> -- reactive client with a functional,
fluent API. It is built on a non-blocking foundation for async and sync scenarios and
supports Reactive Streams back pressure.
[[rest-resttemplate]]
==== RestTemplate
Invoking RESTful services in Java is typically done using a helper class such as Apache
HttpComponents `HttpClient`. For common REST operations this approach is too low level as
shown below.
[source,java,indent=0]
[subs="verbatim,quotes"]
----
String uri = "http://example.com/hotels/1/bookings";
PostMethod post = new PostMethod(uri);
String request = // create booking request content
post.setRequestEntity(new StringRequestEntity(request));
httpClient.executeMethod(post);
if (HttpStatus.SC_CREATED == post.getStatusCode()) {
Header location = post.getRequestHeader("Location");
if (location != null) {
System.out.println("Created new booking at :" + location.getValue());
}
}
----
RestTemplate provides higher level methods that correspond to each of the six main HTTP
methods that make invoking many RESTful services a one-liner and enforce REST best
practices.
The `RestTemplate` provides a higher level API over HTTP client libraries with methods
that correspond to each of the six main HTTP methods that make invoking many RESTful
services a one-liner and enforce REST best practices.
[NOTE]
@@ -1373,6 +1347,8 @@ The `AsyncRestTemplate` is deprecated.
Please use the <<web-reactive.adoc#webflux-client,WebClient>> instead.
include::web/webflux-client.adoc[leveloffset=+3]
[[ejb]]