インターフェース RestClient
public interface RestClient
HTTP リクエストを実行するクライアント。JDK
HttpClient、Apache HttpComponents などの基盤となる HTTP クライアントライブラリを介して、スムーズな同期 API を公開します。 静的ファクトリメソッド create()、create(String)、または builder() を使用してインスタンスを準備します。RestTemplate と同じ構成を使用するには、create(RestTemplate) または builder(RestTemplate) を使用します。
レスポンス本文を含む例について
リクエスト本文の例については、以下を参照してください。
- 導入:
- 6.1
- 作成者:
- Arjen Poutsma
ネストされたクラスのサマリー
ネストされたクラス修飾子と型インターフェース説明static interfaceRestClientを作成するための可変ビルダー。static interface交換に至るまでのリクエストヘッダーと本文を指定するための契約。static interfaceリクエストのリクエストヘッダー、本文、URI を指定するための契約。static interface交換に至るまでのリクエストヘッダーを指定するための契約。static interfaceリクエストのリクエストヘッダーと URI を指定するための契約。static interface交換後のレスポンス操作を指定するための契約。static interfaceRestClient.UriSpec<S extends RestClient.RequestHeadersSpec<?>>リクエストの URI を指定するための契約。メソッドのサマリー
修飾子と型メソッド説明static RestClient.Builderbuilder()RestClientビルダーを入手します。static RestClient.Builderbuilder(RestTemplate restTemplate) 指定されたRestTemplateの構成に基づいてRestClientビルダーを取得します。static RestClientcreate()新しいRestClientを作成します。static RestClientデフォルトのベース URL を受け入れるcreate()のバリアント。static RestClientcreate(RestTemplate restTemplate) 指定されたRestTemplateの構成に基づいて新しいRestClientを作成します。delete()HTTP DELETE リクエストの作成を開始します。get()HTTP GET リクエストの作成を開始します。head()HTTP HEAD リクエストの構築を開始します。method(HttpMethod method) 指定されたHttpMethodのリクエストの構築を開始します。mutate()このRestClientから設定が複製される新しいRestClientを作成するためのビルダーを返します。options()HTTP OPTIONS リクエストの作成を開始します。patch()HTTP PATCH リクエストの作成を開始します。post()HTTP POST リクエストの作成を開始します。put()HTTP PUT リクエストの作成を開始します。
メソッドの詳細
get
RestClient.RequestHeadersUriSpec<?> get()HTTP GET リクエストの作成を開始します。- 戻り値:
- ターゲット URL を指定するための仕様
head
RestClient.RequestHeadersUriSpec<?> head()HTTP HEAD リクエストの構築を開始します。- 戻り値:
- ターゲット URL を指定するための仕様
post
HTTP POST リクエストの作成を開始します。- 戻り値:
- ターゲット URL を指定するための仕様
put
HTTP PUT リクエストの作成を開始します。- 戻り値:
- ターゲット URL を指定するための仕様
patch
RestClient.RequestBodyUriSpec patch()HTTP PATCH リクエストの作成を開始します。- 戻り値:
- ターゲット URL を指定するための仕様
delete
RestClient.RequestHeadersUriSpec<?> delete()HTTP DELETE リクエストの作成を開始します。- 戻り値:
- ターゲット URL を指定するための仕様
options
RestClient.RequestHeadersUriSpec<?> options()HTTP OPTIONS リクエストの作成を開始します。- 戻り値:
- ターゲット URL を指定するための仕様
method
指定されたHttpMethodのリクエストの構築を開始します。- 戻り値:
- ターゲット URL を指定するための仕様
mutate
RestClient.Builder mutate()このRestClientから設定が複製される新しいRestClientを作成するためのビルダーを返します。create
新しいRestClientを作成します。create
デフォルトのベース URL を受け入れるcreate()のバリアント。詳細については、Builder.baseUrl(String)を参照してください。- パラメーター:
baseUrl- すべてのリクエストのベース URI- 関連事項:
create
指定されたRestTemplateの構成に基づいて新しいRestClientを作成します。返されたビルダーはテンプレートの設定で構成されます- パラメーター:
restTemplate- 返されたクライアントの構成のベースとなる Rest テンプレート- 戻り値:
restTemplateの構成で初期化されたRestClient
builder
RestClientビルダーを入手します。builder
指定されたRestTemplateの構成に基づいてRestClientビルダーを取得します。返されたビルダーはテンプレートの設定で構成されます- パラメーター:
restTemplate- 返されたビルダーの構成のベースとなる Rest テンプレート- 戻り値:
restTemplateの構成で初期化されたRestClientビルダー