インターフェース RestTestClient.Builder<B extends RestTestClient.Builder<B>>
- 型パラメーター:
B- ビルダーの種類
- すべての既知のサブインターフェース:
RestTestClient.MockMvcSetupBuilder<S,、M> RestTestClient.RouterFunctionSetupBuilder、RestTestClient.StandaloneSetupBuilder、RestTestClient.WebAppContextSetupBuilder
- 含まれているインターフェース:
RestTestClient
public static interface RestTestClient.Builder<B extends RestTestClient.Builder<B>>
RestClient.Builder を介して基礎となる RestClient をカスタマイズする手順。- 導入:
- 7.0
- 作成者:
- Rob Worsnop, Rossen Stoyanchev
メソッドのサマリー
修飾子と型メソッド説明<T extends B>
TapiVersionInserter(ApiVersionInserter apiVersionInserter) RestTestClient.RequestHeadersSpec.apiVersion(Object)で指定された API バージョンがリクエストに挿入される方法を抽象化するためにApiVersionInserterを構成します。<T extends B>
TRestClient.create(String)の説明に従ってベース URI を構成します。build()RestTestClientインスタンスをビルドします。<T extends B>
Tリクエストとレスポンスの本文に使用するメッセージコンバーターを構成します。<T extends B>
TdefaultApiVersion(ObjectSE version) まだ設定されていない場合に、すべてのリクエストに追加する API バージョンを指定するグローバルオプション。<T extends B>
TdefaultCookie(StringSE cookieName, StringSE... cookieValues) 指定された Cookie を、まだ追加されていないすべてのリクエストに追加します。<T extends B>
TdefaultCookies(ConsumerSE<MultiValueMap<StringSE, StringSE>> cookiesConsumer) 指定されたコンシューマーでデフォルトの Cookie を操作します。<T extends B>
TdefaultHeader(StringSE headerName, StringSE... headerValues) 指定されたヘッダーを追加していないすべてのリクエストに追加します。<T extends B>
TdefaultHeaders(ConsumerSE<HttpHeaders> headersConsumer) 指定されたコンシューマーでデフォルトのヘッダーを操作します。<T extends B>
TentityExchangeResultConsumer(ConsumerSE<EntityExchangeResult<?>> consumer) レスポンスが単一のエンティティ、エンティティのリスト、byte[] に完全にデコードされるたびに呼び出されるEntityExchangeResultコールバックを構成します。<T extends B>
TrequestInterceptor(ClientHttpRequestInterceptor interceptor) 指定されたリクエストインターセプターをインターセプターチェーンの最後に追加します。<T extends B>
TrequestInterceptors(ConsumerSE<ListSE<ClientHttpRequestInterceptor>> interceptorsConsumer) 指定されたコンシューマーを使用してインターセプタを操作します。<T extends B>
TuriBuilderFactory(UriBuilderFactory uriBuilderFactory) baseUrl(String)の代替として、また事実上オーバーライドするために、事前に構成されたUriBuilderFactoryインスタンスを提供します。
メソッドの詳細
baseUrl
RestClient.create(String)の説明に従ってベース URI を構成します。- 戻り値:
- このビルダー
uriBuilderFactory
baseUrl(String)の代替として、また事実上オーバーライドするために、事前に構成されたUriBuilderFactoryインスタンスを提供します。- 戻り値:
- このビルダー
defaultHeader
defaultHeaders
指定されたコンシューマーでデフォルトのヘッダーを操作します。コンシューマーに提供されるヘッダーは「ライブ」であるため、コンシューマーを使用して既存のヘッダー値を上書きしたり、値を削除したり、他のHttpHeadersメソッドを使用したりできます。- パラメーター:
headersConsumer-HttpHeadersを消費する関数- 戻り値:
- このビルダー
defaultCookie
defaultCookies
指定されたコンシューマーでデフォルトの Cookie を操作します。コンシューマーに提供されるマップは「ライブ」であるため、コンシューマーを使用して、既存のヘッダー値を上書きしたり、値を削除しSEたり、その他のMultiValueMapメソッドを使用したりできます。- パラメーター:
cookiesConsumer- Cookie マップを使用する関数- 戻り値:
- このビルダー
defaultApiVersion
apiVersionInserter
RestTestClient.RequestHeadersSpec.apiVersion(Object)で指定された API バージョンがリクエストに挿入される方法を抽象化するためにApiVersionInserterを構成します。- パラメーター:
apiVersionInserter- 使用するインサーター
requestInterceptor
指定されたリクエストインターセプターをインターセプターチェーンの最後に追加します。- パラメーター:
interceptor- チェーンに追加されるインターセプター
requestInterceptors
<T extends B> T requestInterceptors(ConsumerSE<ListSE<ClientHttpRequestInterceptor>> interceptorsConsumer) 指定されたコンシューマーを使用してインターセプタを操作します。コンシューマーに提供されるリストは「ライブ」であるため、コンシューマーはインターセプタの削除、順序の変更などに使用できます。- パラメーター:
interceptorsConsumer- インターセプターのリストを使用する関数- 戻り値:
- このビルダー
configureMessageConverters
<T extends B> T configureMessageConverters(ConsumerSE<HttpMessageConverters.ClientBuilder> configurer) リクエストとレスポンスの本文に使用するメッセージコンバーターを構成します。- パラメーター:
configurer- 空のHttpMessageConverters.ClientBuilderに適用するコンフィギュレーター。- 戻り値:
- このビルダー
entityExchangeResultConsumer
レスポンスが単一のエンティティ、エンティティのリスト、byte[] に完全にデコードされるたびに呼び出されるEntityExchangeResultコールバックを設定します。これは実質的に、以下の各コールバックと同等ですが、グローバルに一度だけ登録されます。client.get().uri("/accounts/1") .exchange() .expectBody(Person.class).consumeWith(exchangeResult -> ... )); client.get().uri("/accounts") .exchange() .expectBodyList(Person.class).consumeWith(exchangeResult -> ... )); client.get().uri("/accounts/1") .exchange() .expectBody().consumeWith(exchangeResult -> ... ));構成されたコンシューマーは、
Flux<T>にデコードされたレスポンスには適用されないことに注意してください。レスポンスは、reactor.test.StepVerifierなどを介してテストクライアントのワークフローの外部で使用できます。- パラメーター:
consumer- エンティティのレスポンスに適用するコンシューマー- 戻り値:
- ビルダー
build
RestTestClient build()RestTestClientインスタンスをビルドします。