インターフェース RestTestClient.RequestHeadersSpec<S extends RestTestClient.RequestHeadersSpec<S>>
- 型パラメーター:
S- 仕様型への自己参照
- すべての既知のサブインターフェース:
RestTestClient.RequestBodySpec, RestTestClient.RequestBodyUriSpec, RestTestClient.RequestHeadersUriSpec<S>
- 含まれているインターフェース:
RestTestClient
public static interface RestTestClient.RequestHeadersSpec<S extends RestTestClient.RequestHeadersSpec<S>>
リクエストヘッダーを追加し、交換を実行するための仕様。
- 導入:
- 7.0
- 作成者:
- Rob Worsnop, Rossen Stoyanchev
方法の概要
修飾子と型メソッド説明Acceptヘッダーで指定されているように、受け入れ可能なメディア型のリストを設定します。acceptCharset(CharsetSE... acceptableCharsets) Accept-Charsetヘッダーで指定されているように、受け入れ可能な文字SEセットのリストを設定します。apiVersion(@Nullable ObjectSE version) リクエストの API バージョンを設定します。指定された名前の属性に指定された値を設定します。attributes(ConsumerSE<MapSE<StringSE, ObjectSE>> attributesConsumer) 指定されたコンシューマーでリクエスト属性を操作します。指定された名前と値で Cookie を追加します。cookies(ConsumerSE<MultiValueMap<StringSE, StringSE>> cookiesConsumer) 指定されたコンシューマーでこのリクエストの Cookie を操作します。exchange()交換を実行します。正常なレスポンスを期待するexchange()のバリアント。指定された名前に、指定された単一のヘッダー値を追加します。headers(ConsumerSE<HttpHeaders> headersConsumer) 指定されたコンシューマーでリクエストのヘッダーを操作します。ifModifiedSince(ZonedDateTimeSE ifModifiedSince) If-Modified-Sinceヘッダーの値を設定します。ifNoneMatch(StringSE... ifNoneMatches) If-None-Matchヘッダーの値を設定します。
メソッドの詳細
accept
acceptCharset
Accept-Charsetヘッダーで指定されているように、受け入れ可能な文字SEセットのリストを設定します。- パラメーター:
acceptableCharsets- 許容される文字セット- 戻り値:
- リクエストのさらなる宣言のためのこの仕様
cookie
cookies
指定されたコンシューマーでこのリクエストの Cookie を操作します。コンシューマーに提供されるマップは「ライブ」であるため、コンシューマーを使用して、既存のヘッダー値を上書きしたり、値を削除しSEたり、その他のMultiValueMapメソッドを使用したりできます。- パラメーター:
cookiesConsumer- Cookie マップを使用する関数- 戻り値:
- リクエストのさらなる宣言のためのこの仕様
ifModifiedSince
If-Modified-Sinceヘッダーの値を設定します。日付は、1970 年 1 月 1 日 GMT からのミリ秒数として指定する必要があります。
- パラメーター:
ifModifiedSince- ヘッダーの新しい値- 戻り値:
- リクエストのさらなる宣言のためのこの仕様
ifNoneMatch
header
headers
指定されたコンシューマーでリクエストのヘッダーを操作します。コンシューマーに提供されるヘッダーは「ライブ」であるため、コンシューマーを使用して、既存のヘッダー値を上書きしたり、値を削除したり、他のHttpHeadersメソッドを使用したりできます。- パラメーター:
headersConsumer-HttpHeadersを消費する関数- 戻り値:
- リクエストのさらなる宣言のためのこの仕様
apiVersion
リクエストの API バージョンを設定します。バージョンはconfiguredApiVersionInserterを通じてリクエストに挿入されます。バージョンが設定されていない場合は、
defaultApiVersionが使用されます (構成されている場合)。nullが渡された場合、デフォルトのバージョン設定に関係なく、API バージョンは挿入されません。- パラメーター:
version- リクエストの API バージョン。これは、文字列、またはApiVersionFormatterなどを使用して挿入子でフォーマットできるオブジェクトになります。- 戻り値:
- リクエストのさらなる宣言のためのこの仕様
attribute
attributes
指定されたコンシューマーでリクエスト属性を操作します。コンシューマーに提供される属性は「ライブ」であるため、コンシューマーを使用して、属性をインスペクションしたり、属性を削除したり、マップが提供する他のメソッドを使用したりできます。- パラメーター:
attributesConsumer- 属性を使用する関数- 戻り値:
- リクエストのさらなる宣言のためのこの仕様
exchange
RestTestClient.ResponseSpec exchange()交換を実行します。返された仕様は、次の 2 つの方法のいずれかで使用できます。
- 仕様上のメソッドを使用して、レスポンスの期待値のチェーンでリクエストワークフローを継承します。
- 仕様を
RestTestClientResponse.from(ResponseSpec)でラップし、AssertJ ステートメントでレスポンスを検証する
- 戻り値:
- レスポンスの期待値に関する仕様
exchangeSuccessfully
RestTestClient.ResponseSpec exchangeSuccessfully()exchange()の変異体で、成功レスポンスを期待します。実質的には、以下のショートカットです。exchange().expectStatus().is2xxSuccessful()
- 戻り値:
- レスポンスの期待値に関する仕様