インターフェース WebTestClient.BodyContentSpec
- 含まれているインターフェース:
- WebTestClient
public static interface WebTestClient.BodyContentSpec
レスポンス本文の内容に対する期待の仕様。
方法の概要
修飾子と型メソッド説明consumeWith
(ConsumerSE<EntityExchangeResult<byte[]>> consumer) 指定されたConsumer
SE でレスポンス本文の内容をアサートします。isEmpty()
レスポンス本体が空であることをアサートし、交換結果を返します。default WebTestClient.BodyContentSpec
予想されるレスポンスコンテンツと実際のレスポンスコンテンツを JSON として解析し、比較を実行して、寛大なチェック(拡張可能で非厳密な配列順序)によるフォーマットに関係なく、同じ属性と値のペアが含まれていることを確認します。使用すべきではありません。json
(StringSE expectedJson, JsonComparator comparator) 予想されるレスポンスコンテンツと実際のレスポンスコンテンツを JSON として解析し、指定されたJsonComparator
を使用して比較を実行します。json
(StringSE expectedJson, JsonCompareMode compareMode) 予想されるレスポンスコンテンツと実際のレスポンスコンテンツを JSON として解析し、指定されたモードを使用して比較を実行します。非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。String.formatted(Object...)
SE に事前を呼び出すことを推奨EntityExchangeResult<byte[]>
チェーン API を終了し、未加工のレスポンスコンテンツを含むExchangeResult
を返します。期待されるレスポンスコンテンツと実際のレスポンスコンテンツを XML として解析し、2 つが「類似」している、つまりdefault XpathAssertions
XPath 式を使用して本文の特定のサブセットをインスペクションするレスポンス本文のアサーションへのアクセス。ボディの特定のサブセットをインスペクションするために XPath 式を使用して、特定のネームスペースを持つレスポンスボディアサーションへのアクセス。
メソッドの詳細
isEmpty
EntityExchangeResult<VoidSE> isEmpty()レスポンス本体が空であることをアサートし、交換結果を返します。json
予想されるレスポンスコンテンツと実際のレスポンスコンテンツを JSON として解析し、比較を実行して、寛大なチェック(拡張可能で非厳密な配列順序)によるフォーマットに関係なく、同じ属性と値のペアが含まれていることを確認します。このメソッドを使用するには、JSONassert ライブラリがクラスパス上にある必要があります。
- パラメーター:
expectedJson
- 予期される JSON コンテンツ- 関連事項:
json
@DeprecatedSE(since="6.2") WebTestClient.BodyContentSpec json(StringSE expectedJson, boolean strict) 使用すべきではありません。予想されるレスポンスコンテンツと実際のレスポンスコンテンツを JSON として解析し、フォーマットに関係なく、それらに同じ属性と値のペアが含まれていることを確認する比較を実行します。strict
パラメーター値に応じて、2 つのモードで比較できます。true
: 厳密なチェック。拡張可能で厳密な配列順序ではありません。false
: 寛大なチェック。拡張可能で厳密でない配列の順序。
このメソッドを使用するには、JSONassert ライブラリがクラスパス上にある必要があります。
- パラメーター:
expectedJson
- 予期される JSON コンテンツstrict
-true
かどうかの厳密なチェックを有効にします- 導入:
- 5.3.16
- 関連事項:
json
予想されるレスポンスコンテンツと実際のレスポンスコンテンツを JSON として解析し、指定された mode を使用して比較を実行します。比較が失敗した場合は、JsonComparison
のメッセージを含むAssertionError
SE をスローします。このメソッドを使用するには、JSONassert ライブラリがクラスパス上にある必要があります。
- パラメーター:
expectedJson
- 予期される JSON コンテンツcompareMode
- 比較モード- 導入:
- 6.2
- 関連事項:
json
予想されるレスポンスコンテンツと実際のレスポンスコンテンツを JSON として解析し、指定されたJsonComparator
を使用して比較を実行します。比較が失敗した場合は、JsonComparison
のメッセージを含むAssertionError
SE をスローします。- パラメーター:
expectedJson
- 予期される JSON コンテンツcomparator
- 使用する比較器- 導入:
- 6.2
xml
期待されるレスポンスコンテンツと実際のレスポンスコンテンツを XML として解析し、2 つが「類似」していること、つまり、順序に関係なく同じ要素と属性が含まれていることを表明します。このメソッドを使用するには、クラスパスに XMLUnit ライブラリが必要です。
- パラメーター:
expectedXml
- 期待される XML コンテンツ。- 導入:
- 5.1
- 関連事項:
jsonPath
- パラメーター:
expression
- JsonPath 式- 導入:
- 6.2
jsonPath
@DeprecatedSE(since="6.2", forRemoval=true) JsonPathAssertions jsonPath(StringSE expression, ObjectSE... args) 非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。String.formatted(Object...)
SE に事前を呼び出すことを推奨JsonPath 式を使用して本文の特定のサブセットをインスペクションするレスポンス本文のアサーションへのアクセス。JSON パス式は、
String.format(java.lang.String, java.lang.Object...)
SE で定義されているフォーマット指定子を使用して、パラメーター化されたストリングにすることができます。- パラメーター:
expression
- JsonPath 式args
- 式をパラメーター化する引数
xpath
XPath 式を使用して本文の特定のサブセットをインスペクションするレスポンス本文のアサーションへのアクセス。XPath 式は、
String.format(java.lang.String, java.lang.Object...)
SE で定義されている書式指定子を使用して、パラメーター化された文字列にすることができます。- パラメーター:
expression
- XPath 式args
- 式をパラメーター化する引数- 導入:
- 5.1
- 関連事項:
xpath
XpathAssertions xpath(StringSE expression, @Nullable MapSE<StringSE, StringSE> namespaces, ObjectSE... args) ボディの特定のサブセットをインスペクションするために XPath 式を使用して、特定のネームスペースを持つレスポンスボディアサーションへのアクセス。XPath 式は、
String.format(java.lang.String, java.lang.Object...)
SE で定義されている書式指定子を使用して、パラメーター化された文字列にすることができます。- パラメーター:
expression
- XPath 式namespaces
- 使用する名前空間args
- 式をパラメーター化する引数- 導入:
- 5.1
consumeWith
指定されたConsumer
SE でレスポンス本文の内容をアサートします。- パラメーター:
consumer
- レスポンス本文のコンシューマー。レスポンス本文がない場合、入力byte[]
はnull
になる場合があります。
returnResult
EntityExchangeResult<byte[]> returnResult()チェーン API を終了し、未加工のレスポンスコンテンツを含むExchangeResult
を返します。
json(String, JsonCompareMode)
を推奨