Handling Lists with a Dynamic Number of Items

JSON リストプロセッサの一般的な使用例は、動的なアイテム数を持つリストを含む API リクエストを処理することです。例えば、次のようなリクエストを送信したとします。

リクエスト

{
    "request": {
        "items": [
            { "id": 1, "name": "William" },
            { "id": 2, "name": "Beverly" },
            { "id": 3, "name": "Richard" }
        ]
    }
}

以下のようなレスポンスを期待するとします。

期待されるレスポンス

{
    "response" : {
        "itemResponses" : [
            { "id": 1, "name": "William", "balance" : 72500.13 },
            { "id": 2, "name": "Beverly", "balance" : 33000.99 },
            { "id": 3, "name": "Richard", "balance" : 42010.75 }
        ]
    }
}

これを実現するには、JSON リストプロセッサを使用します。以下のワークフローがその方法を示しています。

新しい .pva を作成し、スイートに JSON レスポンダーを追加します。
JSON レスポンダーで、[オプション] > [リクエストテンプレート] に移動し、上記のサンプルリクエストペイロードを追加します。
[レスポンス] タブで、以下のリテラルペイロードを追加します。
```
{
    "response" : {
        "itemResponses" : [
            ${Outgoing List}
        ]
    }
}
```
注：${Outgoing List} 変数は、JSON リストプロセッサーによって処理された各アイテムの集約されたレスポンスを使用して、実行時に解決されます。
変更を保存します。
レスポンダーの受信リクエスト出力に JSON List Processor を連結します (右クリック > [出力の追加] > [ペイロード] > [JSON リストプロセッサ])。
JSON リストプロセッサが item オブジェクトノードを抽出するように設定します。生成された XPath は、items 配列の下にあるすべてのアイテムを自動的に選択します。
変更を保存します。
(オプション) 実行時の可視性を高めるために、拡張ツールを使用して処理済みの各項目をコンソールに出力できます。
1. 拡張ツールを JSON リストプロセッサに連結します (右クリック > [出力の追加] > [受信項目] > [拡張ツール])。
2. 拡張ツールに次の Groovy スクリプトを追加します。
```
import com.parasoft.api.Application
def showMessage(input, context) {    
Application.showMessage("Extension Tool Output - Incoming Item:\n" + input + "\n")
```
3. 変更を保存します。
データソース応答条件を実行するには、スイートにテーブルデータソースを追加します (右クリック > [新規追加] > [データソース] > [テーブル])。
[１行目は列名を表す] チェックボックスをオンにします。
次のデータを追加します。
id name balance
1 William 72500.13
2 Beverly 33000.99
3 Richard 42010.75
変更を保存します。
JSON リストプロセッサに JSON メッセージレスポンダーを連結します (右クリック > [レスポンダーの追加] > [JSON メッセージレスポンダー]）。レスポンダーの名前を「Success Responder」にします。
[オプション] > [リクエストテンプレート] に移動し、次のペイロードを追加します。
```
{
   "id": 1,
   "name": "William"
}
```
[データソース応答条件」> [リクエストボディ] に移動し、id フィールドの応答条件を設定し、データソース列 id を使用します。
[レスポンス] タブをクリックし、次のリテラルペイロードを追加します。
```
{
    "id" : ${id},
    "name" : "${name}",
    "balance" : ${balance}
}
```
変更を保存します。
.tst または .pvn ファイルを使用して仮想アセットに POST リクエストを送信し、期待どおりのレスポンスが返されることを確認します。

エラー処理

.pva でエラーを処理する方法はいくつかあります。上記で作成したレスポンダースイートに、次のいずれか (または両方) を追加します。

オプション 1: 無効なアイテムに対してカスタムエラーメッセージを返す

アイテムの ID がデータソースに存在しない場合、そのアイテムに対してカスタムエラーメッセージを返すことができます。

JSON メッセージレスポンダーを JSON リストプロセッサに連結します (右クリック > [レスポンダーの追加] > [JSON メッセージレスポンダー] ) 。
レスポンダーに「Error Responder – Return error for invalid id」という名前を付けます。
[レスポンス] タブをクリックし、次のリテラルペイロードを追加します。
```
{
    "id" : “${{=/root/id/text()}}”,
    "error" : {
        "code" : "NOT_FOUND",
        "message" : "No active account found for id '${{=/root/id/text()}}'."
      }
}
```
このペイロードは、インライン式を使用して、受信した JSON から直接値を抽出します。あるいは、JSON データバンクを使用して値を抽出することもできます。

次のペイロードを含む POST リクエストを仮想アセットに送信し、レスポンスにエラーメッセージが含まれていることを確認します。

{
    "request": {
        "items": [
            { "id": 1, "name": "William" },
            { "id": 13, "name": "George" },
            { "id": 2, "name": "Beverly" },
            { "id": 3, "name": "Richard" }
        ]
}

オプション 2: 無効な項目を無視して集計しない

送信リストから無効な項目を除外したい場合は、エラーレスポンダーに空のレスポンスを設定します。これにより、JSON リストプロセッサはそれらの項目を集計から除外します。

JSON メッセージレスポンダーを JSON リストプロセッサに連結します (右クリック > [レスポンダーの追加] > [JSON メッセージレスポンダー] ) 。
レスポンダーに「Error Responder – Ignore invalid id」という名前を付けます。
[レスポンス] タブをクリックし、空のリテラルペイロードを設定します。
上記のオプション 1 で説明したようなエラーレスポンダーを設定している場合は、無効にします。
仮想アセットに最後の POST リクエストを再送信し、無効な項目がレスポンスに含まれていないことを確認します。

id	name	balance
1	William	72500.13
2	Beverly	33000.99
3	Richard	42010.75

Page tree

Handling Lists with a Dynamic Number of Items

エラー処理