Polishing in RestClient reference docs

This commit is contained in:
rstoyanchev 2025-05-13 15:33:38 +01:00
parent cce2771639
commit 5cb3ea228e
1 changed files with 20 additions and 13 deletions

View File

@ -12,17 +12,24 @@ The Spring Framework provides the following choices for making calls to REST end
[[rest-restclient]] [[rest-restclient]]
== `RestClient` == `RestClient`
The `RestClient` is a synchronous HTTP client that offers a modern, fluent API. `RestClient` is a synchronous HTTP client that provides a fluent API to perform requests.
It offers an abstraction over HTTP libraries that allows for convenient conversion from a Java object to an HTTP request, and the creation of objects from an HTTP response. It serves as an abstraction over HTTP libraries, and handles conversion of HTTP request and response content to and from higher level Java objects.
=== Creating a `RestClient` === Create a `RestClient`
The `RestClient` is created using one of the static `create` methods. `RestClient` has static `create` shortcut methods.
You can also use `builder()` to get a builder with further options, such as specifying which HTTP library to use (see <<rest-request-factories>>) and which message converters to use (see <<rest-message-conversion>>), setting a default URI, default path variables, default request headers, or `uriBuilderFactory`, or registering interceptors and initializers. It also exposes a `builder()` with further options:
Once created (or built), the `RestClient` can be used safely by multiple threads. - select the HTTP library to use, see <<rest-request-factories>>
- configure message converters, see <<rest-message-conversion>>
- set a baseUrl
- set default request headers, cookies, path variables
- register interceptors
- register request initializers
The following sample shows how to create a default `RestClient`, and how to build a custom one. Once created, a `RestClient` is safe to use in multiple threads.
The below shows how to create or build a `RestClient`:
[tabs] [tabs]
====== ======
@ -63,17 +70,17 @@ Kotlin::
---- ----
====== ======
=== Using the `RestClient` === Use the `RestClient`
When making an HTTP request with the `RestClient`, the first thing to specify is which HTTP method to use. To perform an HTTP request, first specify the HTTP method to use.
This can be done with `method(HttpMethod)` or with the convenience methods `get()`, `head()`, `post()`, and so on. Use the convenience methods like `get()`, `head()`, `post()`, and others, or `method(HttpMethod)`.
==== Request URL ==== Request URL
Next, the request URI can be specified with the `uri` methods. Next, specify the request URI with the `uri` methods.
This step is optional and can be skipped if the `RestClient` is configured with a default URI. This is optional, and you can skip this step if you configured a baseUrl through the builder.
The URL is typically specified as a `String`, with optional URI template variables. The URL is typically specified as a `String`, with optional URI template variables.
The following example configures a GET request to `https://example.com/orders/42`: The following shows how to perform a request:
[tabs] [tabs]
====== ======