インターフェース RestClient
public interface RestClient
HTTP リクエストを実行するクライアント。JDK
HttpClient
、Apache HttpComponents などの基盤となる HTTP クライアントライブラリを介して、スムーズな同期 API を公開します。 静的ファクトリメソッド create()
、create(String)
、または builder()
を使用してインスタンスを準備します。RestTemplate
と同じ構成を使用するには、create(RestTemplate)
または builder(RestTemplate)
を使用します。
レスポンス本文を含む例について
リクエスト本文の例については、以下を参照してください。
- 導入:
- 6.1
- 作成者:
- Arjen Poutsma, Sebastien Deleuze
ネストされたクラスのサマリー
修飾子と型インターフェース説明static interface
RestClient
を作成するための可変ビルダー。static interface
交換に至るまでのリクエストヘッダーと本文を指定するための契約。static interface
リクエストのリクエストヘッダー、本文、URI を指定するための契約。static interface
交換に至るまでのリクエストヘッダーを指定するための契約。static interface
リクエストのリクエストヘッダーと URI を指定するための契約。static interface
交換後のレスポンス操作を指定するための契約。static interface
RestClient.UriSpec<S extends RestClient.RequestHeadersSpec<?>>
リクエストの URI を指定するための契約。メソッドのサマリー
修飾子と型メソッド説明static RestClient.Builder
builder()
RestClient
ビルダーを入手します。static RestClient.Builder
builder
(RestTemplate restTemplate) 指定されたRestTemplate
の構成に基づいてRestClient
ビルダーを取得します。static RestClient
create()
新しいRestClient
を作成します。static RestClient
デフォルトのベース URL を受け入れるcreate()
のバリアント。static RestClient
デフォルトのベースURI
を受け入れるcreate()
のバリアント。static RestClient
create
(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
- パラメーター:
baseUrl
- すべてのリクエストのベース URI- 導入:
- 6.2
- 関連事項:
create
指定されたRestTemplate
の構成に基づいて新しいRestClient
を作成します。返されるビルダーは、テンプレートの次の属性で構成されます。
- パラメーター:
restTemplate
- 返されたクライアントの構成のベースとなる Rest テンプレート- 戻り値:
restTemplate
の構成で初期化されたRestClient
builder
RestClient
ビルダーを入手します。builder
指定されたRestTemplate
の構成に基づいてRestClient
ビルダーを取得します。返されるビルダーは、テンプレートの次の属性で構成されます。
- パラメーター:
restTemplate
- 返されたビルダーの構成のベースとなる Rest テンプレート- 戻り値:
restTemplate
の構成で初期化されたRestClient
ビルダー