インターフェース RestTestClient
public interface RestTestClient
内部で
RestClient
を使用してリクエストを実行する一方で、レスポンスを検証する流れるような API を提供する Web サーバーをテストするためのクライアント。 このクライアントは、HTTP 経由で任意のサーバーに接続したり、モックリクエストとレスポンスを使用して MockMvc
サーバーに接続したりできます。
インスタンスを作成するには、bindToXxx()
メソッドのいずれかを使用します。例:
- 導入:
- 7.0
- 作成者:
- Rob Worsnop, Rossen Stoyanchev
ネストされたクラスのサマリー
ネストされたクラス修飾子と型インターフェース説明static interface
レスポンス本文の内容に対する期待の仕様。static interface
RestTestClient.BodySpec<B, S extends RestTestClient.BodySpec<B,
S>> 単一のオブジェクトにデコードされたレスポンス本文に対する期待の仕様。static interface
RestTestClient.Builder<B extends RestTestClient.Builder<B>>
RestClient.Builder
を介して基礎となるRestClient
をカスタマイズする手順。static interface
RestTestClient.MockMvcSetupBuilder<S extends RestTestClient.Builder<S>, M extends MockMvcBuilder>
MockMvc サーバーに対するテスト用のRestTestClient.Builder
の拡張。static interface
リクエストの本文を提供するための仕様。static interface
リクエストの本文と URI を提供するための仕様。static interface
リクエストヘッダーを追加し、交換を実行するための仕様。static interface
リクエストヘッダーとリクエストの URI を提供するための仕様。static interface
アサーションをレスポンスに適用するための連鎖 API。static interface
RouterFunction MockMvc セットアップに対するテストのためのRestTestClient.Builder
の拡張。static interface
スタンドアロンの MockMvc セットアップに対するテスト用のRestTestClient.Builder
の拡張。static interface
RestTestClient.UriSpec<S extends RestTestClient.RequestHeadersSpec<?>>
リクエストの URI を提供するための仕様。static interface
WebAppContext MockMvc セットアップに対するテストのためのRestTestClient.Builder
の拡張。フィールドのサマリー
フィールド修飾子と型フィールド説明static final StringSE
RestTestClient
を介して実行されるすべてのリクエストに一意の ID を割り当てるために使用されるリクエストヘッダーの名前。メソッドのサマリー
修飾子と型メソッド説明static RestTestClient.Builder
<?> サーバーとして使用するために、すでに初期化されたMockMvc
インスタンスを提供することにより、RestTestClient
の作成を開始します。WebApplicationContext MockMvc セットアップを使用してRestTestClient
の作成を開始します。bindToController
(ObjectSE... controllers) スタンドアロン MockMvc セットアップを使用してRestTestClient
の作成を開始します。bindToRouterFunction
(RouterFunction<?>... routerFunctions) RouterFunction MockMvc セットアップを使用してRestTestClient
の作成を開始します。static RestTestClient.Builder
<?> このサーバー設定オプションを使用すると、ライブサーバーに接続できます。static RestTestClient.Builder
<?> bindToServer
(ClientHttpRequestFactory requestFactory) 事前設定されたリクエストファクトリを備えたbindToServer()
のバリアント。delete()
HTTP DELETE リクエストを準備します。get()
HTTP GET リクエストを準備します。head()
HTTP HEAD リクエストを準備します。method
(HttpMethod method) 指定されたHttpMethod
のリクエストを準備します。<B extends RestTestClient.Builder<B>>
RestTestClient.Builder<B> mutate()
このテストクライアントのプロパティを変更するためのビルダーを返します。options()
HTTP OPTIONS リクエストを準備します。patch()
HTTP PATCH リクエストを準備します。post()
HTTP POST リクエストを準備します。put()
HTTP PUT リクエストを準備します。
フィールドの詳細
RESTTESTCLIENT_REQUEST_ID
RestTestClient
を介して実行されるすべてのリクエストに一意の ID を割り当てるために使用されるリクエストヘッダーの名前。これは、リクエスト処理のすべてのフェーズ(サーバー側コンポーネントからのリクエストなど)でその ID のコンテキスト情報を保存し、後でExchangeResult
が利用可能になったときにその情報を参照できます。- 関連事項:
メソッドの詳細
get
head
post
put
patch
delete
options
RestTestClient.RequestHeadersUriSpec<?> options()HTTP OPTIONS リクエストを準備します。- 戻り値:
- ターゲット URL を指定するための仕様
method
指定されたHttpMethod
のリクエストを準備します。- 戻り値:
- ターゲット URL を指定するための仕様
mutate
このテストクライアントのプロパティを変更するためのビルダーを返します。bindToController
スタンドアロン MockMvc セットアップを使用してRestTestClient
の作成を開始します。bindToRouterFunction
static RestTestClient.RouterFunctionSetupBuilder bindToRouterFunction(RouterFunction<?>... routerFunctions) RouterFunction MockMvc セットアップを使用してRestTestClient
の作成を開始します。bindToApplicationContext
static RestTestClient.WebAppContextSetupBuilder bindToApplicationContext(WebApplicationContext context) WebApplicationContext MockMvc セットアップを使用してRestTestClient
の作成を開始します。bindTo
サーバーとして使用するために、すでに初期化されたMockMvc
インスタンスを提供することにより、RestTestClient
の作成を開始します。bindToServer
このサーバー設定オプションを使用すると、ライブサーバーに接続できます。RestTestClient client = RestTestClient.bindToServer() .baseUrl("http://localhost:8080") .build();
- 戻り値:
- クライアント構成をカスタマイズするためのチェーン API
bindToServer
事前設定されたリクエストファクトリを備えたbindToServer()
のバリアント。- 戻り値:
- クライアント構成をカスタマイズするためのチェーン API