インターフェース RestTestClient
public interface RestTestClient
内部で
RestClient を使用してリクエストを実行する一方で、レスポンスを検証する流れるような API を提供する Web サーバーをテストするためのクライアント。 このクライアントは、HTTP 経由で任意のサーバーに接続したり、モックリクエストとレスポンスを使用して MockMvc サーバーに接続したりできます。
インスタンスを作成するには、bindToXxx() メソッドのいずれかを使用します。例:
- 導入:
- 7.0
- 作成者:
- Rob Worsnop, Rossen Stoyanchev
ネストされたクラスの要約
ネストされたクラス修飾子と型インターフェース説明static interfaceレスポンス本文の内容に対する期待の仕様。static interfaceRestTestClient.BodySpec<B, S extends RestTestClient.BodySpec<B,S>> 単一のオブジェクトにデコードされたレスポンス本文に対する期待の仕様。static interfaceRestTestClient.Builder<B extends RestTestClient.Builder<B>>RestClient.Builderを介して基礎となるRestClientをカスタマイズする手順。static interfaceRestTestClient.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 interfaceRouterFunction MockMvc セットアップに対するテストのためのRestTestClient.Builderの拡張。static interfaceスタンドアロンの MockMvc セットアップに対するテスト用のRestTestClient.Builderの拡張。static interfaceRestTestClient.UriSpec<S extends RestTestClient.RequestHeadersSpec<?>>リクエストの URI を提供するための仕様。static interfaceWebAppContext MockMvc セットアップに対するテストのためのRestTestClient.Builderの拡張。フィールドのサマリー
フィールド修飾子と型フィールド説明static final StringSERestTestClientを介して実行されるすべてのリクエストに一意の 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