インターフェース RestTestClient.Builder<B extends RestTestClient.Builder<B>>

型パラメーター:
B - ビルダーの種類
すべての既知のサブインターフェース:
RestTestClient.MockMvcSetupBuilder<S,M>RestTestClient.RouterFunctionSetupBuilderRestTestClient.StandaloneSetupBuilderRestTestClient.WebAppContextSetupBuilder
含まれているインターフェース:
RestTestClient

public static interface RestTestClient.Builder<B extends RestTestClient.Builder<B>>
RestClient.Builder を介して基礎となる RestClient をカスタマイズする手順。
導入:
7.0
作成者:
Rob Worsnop, Rossen Stoyanchev
  • メソッドの詳細

    • baseUrl

      <T extends B> T baseUrl(StringSE baseUrl)
      RestClient.create(String) の説明に従ってベース URI を構成します。
      戻り値:
      このビルダー
    • uriBuilderFactory

      <T extends B> T uriBuilderFactory(UriBuilderFactory uriBuilderFactory)
      baseUrl(String) の代替として、また事実上オーバーライドするために、事前に構成された UriBuilderFactory インスタンスを提供します。
      戻り値:
      このビルダー
    • defaultHeader

      <T extends B> T defaultHeader(StringSE headerName, StringSE... headerValues)
      指定されたヘッダーを追加していないすべてのリクエストに追加します。
      パラメーター:
      headerName - ヘッダー名
      headerValues - ヘッダー値
      戻り値:
      このビルダー
    • defaultHeaders

      <T extends B> T defaultHeaders(ConsumerSE<HttpHeaders> headersConsumer)
      指定されたコンシューマーでデフォルトのヘッダーを操作します。コンシューマーに提供されるヘッダーは「ライブ」であるため、コンシューマーを使用して既存のヘッダー値を上書きしたり、値を削除したり、他の HttpHeaders メソッドを使用したりできます。
      パラメーター:
      headersConsumer - HttpHeaders を消費する関数
      戻り値:
      このビルダー
    • defaultCookie

      <T extends B> T defaultCookie(StringSE cookieName, StringSE... cookieValues)
      指定された Cookie を、まだ追加されていないすべてのリクエストに追加します。
      パラメーター:
      cookieName - クッキー名
      cookieValues - クッキーの値
      戻り値:
      このビルダー
    • defaultCookies

      <T extends B> T defaultCookies(ConsumerSE<MultiValueMap<StringSE,StringSE>> cookiesConsumer)
      指定されたコンシューマーでデフォルトの Cookie を操作します。コンシューマーに提供されるマップは「ライブ」であるため、コンシューマーを使用して、既存のヘッダー値を上書きしたり、値を削除しSEたり、その他の MultiValueMap メソッドを使用したりできます。
      パラメーター:
      cookiesConsumer - Cookie マップを使用する関数
      戻り値:
      このビルダー
    • defaultApiVersion

      <T extends B> T defaultApiVersion(ObjectSE version)
      まだ設定されていない場合に、すべてのリクエストに追加する API バージョンを指定するグローバルオプション。
      パラメーター:
      version - 使用するバージョン
      戻り値:
      このビルダー
    • apiVersionInserter

      <T extends B> T apiVersionInserter(ApiVersionInserter apiVersionInserter)
      RestTestClient.RequestHeadersSpec.apiVersion(Object) で指定された API バージョンがリクエストに挿入される方法を抽象化するために ApiVersionInserter を構成します。
      パラメーター:
      apiVersionInserter - 使用するインサーター
    • requestInterceptor

      <T extends B> T requestInterceptor(ClientHttpRequestInterceptor interceptor)
      指定されたリクエストインターセプターをインターセプターチェーンの最後に追加します。
      パラメーター:
      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

      <T extends B> T entityExchangeResultConsumer(ConsumerSE<EntityExchangeResult<?>> consumer)
      レスポンスが単一のエンティティ、エンティティのリスト、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 インスタンスをビルドします。