Postman：パラメータ値を変更してリクエストを複数回実行する方法

APIテストにおいて、パラメータ値を変更してリクエストを複数回実行する必要がよくあります。それでは、Postmanで異なるデータセットを用いて、リクエストをループするには、どうしたらいいですか？本文では、その方法について皆さんに紹介します。

リクエストを異なるパラメータ値でループするのはなぜ？

APIテストの際に、パラメータ値を変更してリクエストを複数回実行したり、異なるデータセットでリクエストをループしたりする必要がよくあります。その理由といえば、主に次のような理由があります。

1. 入力値の妥当性確認
   APIは様々な入力値を受け取る可能性があります。異常値や境界値などのエッジケースをテストすることで、APIの入力値に対する適切な処理を確認できます。
2. 異なるユースケースのテスト
   APIは複数のユースケースをサポートしている可能性があります。異なるパラメータ値を使うことで、それぞれのユースケースが適切に処理されるかどうかをテストできます。
3. 複雑な条件の確認
   APIの処理ロジックが複雑な場合、単一のパラメータ値だけでは十分にテストできない可能性があります。パラメータの組み合わせを変えることで、より複雑な条件下での動作を確認できます。
4. レスポンスの妥当性確認
   パラメータ値を変更することで、APIからの各種レスポンス(正常系、異常系)が適切に返されるかどうかを確認できます。
5. 異常系テスト
   意図的に不正なパラメータ値を送信することで、APIの異常系の処理やエラーハンドリングが適切に機能するかをテストできます。
6. パフォーマンステスト
   大量のリクエストを送信したり、大きなペイロードを送ったりすることで、APIのパフォーマンスをテストできます。

つまり、APIテストではパラメータを変更しながら様々な条件下でAPIが適切に動作するかを包括的に確認する必要があるためです。これにより、APIの品質と信頼性を高めることができます。

Postmanとは

Postmanは、API（Application Programming Interface）開発とテストのための人気のあるツールです。Postmanを使用すると、開発者はHTTPリクエストを作成し、APIエンドポイントに送信することができるので、APIの動作をテストしたり、リクエストとレスポンスのデータを確認したりできます。

初心者向け：Postmanの基本的な使い方を

Postmanは、APIテストなどを行うための定番のツールになります。API戦略を実施する場合は、Postmanを利用することで、その効率性を大幅に向上できます。そこで、本文では、基本的なPostmanの使い方を皆さんに紹介して、Postmanを全く使ったことがないユーザーでも、本文の内容を参照して、Postmanを使いこなすことができると思います。

Apidogブログ - Apiに関する先端知識を取得するshimizu chioka

また、Postmanは、機能豊富なインターフェースを提供し、リクエストの作成や編集、ヘッダーの管理、パラメータの設定、レスポンスの確認などを行うことができます。

Postmanでパラメータ値を変更してリクエストを複数回実行する方法

APIをテストする時に、同じリクエストでもパラメータ値を変更しながら、リクエストをループして複数回実行したい場合は、どうしたらいいですか？次は、Postmanでの実現方法を皆さんに紹介します。

テストデータを作る

パラメータ値を変更してリクエストを複数回ループしたい場合は、まずはすべてのパラメータ値を含むテストデータを作る必要があります。例えば、次の画像のように、UserName.jsonというJSONファイルを作成して、５つのユーザー名をこのファイルに入れます。

リクエストで変数を利用する

そして、リクエストで変数を利用します。ここでJSONデータのフィールド名が自動的に変数名になりますので、リクエストの設定で{{username}}という形でテストデータを利用できます。

コレクション実行でテストデータを利用する

そして、このリクエストを含むコレクションを右クリックして、「Run Collection」を選択することで、コレクションを実行します。コレクションの実行画面の「Data」→「Select File」の順にクリックして、先に作成したjsonファイルをインポートします。

jsonデータがインポートされると、「Preview」ボタンをクリックして、テストデータの中身を確認することも可能です。

コレクションを実行して結果を確認する

テストデータに問題がなければ、下の「Run XXXXXX」ボタンをクリックして、当該コレクションを実行することができます。コレクションを実行すると、実行の結果を確認することができますね。今回はGETリクエストで{{username}}という変数を参照しているので、結果として、GETリクエストにテストデータの全てのフイールドを1つずつを追加され、リクエストが複数回ループされることが分かりましたね。

ということで、Postmanでパラメータ値を変更してリクエストを複数回ループしたい場合、Postmanのテストデータを利用することが便利ですね。

Apidogのデータセットでリクエストをより便利にループ

Postmanよりも便利に異なるパラメータ値でリクエストを複数回実行したい場合は、Apidogは優れたオプションになります。Apidogのデータセットを利用することで、より簡単に実現することができます。

Apidogは、非常に包括的なAPIソリューションを提供しています。API設計、ドキュメンテーション、テスト自動化やモックサーバーなどの機能もApidogで自由に利用することができます。次は、Apidogのデータセットの機能を用いて、パラメータを変更してリクエストを複数回ループする方法を皆さんに紹介します。

ステップ⒈Apidogを開き、APIプロジェクトに入ると、右側のメニューから「自動テスト」をクリックします。テストシナリオを作成して、テストステップを追加することができます。ここで保存済みのAPIやAPICaseから参照することもできますし、新しいリクエストを作成することもできます。

ステップ⒉上部のメニューから「テストデータ」を選択すると、直感的なUIでテスト用のデータセットを作成することができますので、非常に便利です。

ステップ⒊テストデータの編集が終わると、自動テストの画面に戻り、「テストデータ」のところでデータを選択します。ここで反復回数が自動計算（定義のデータセット数）になります。

ステップ⒋テストステップのリクエストをクリックして、必要に応じて、パラメータ値を変数名に定義します。

ステップ⒌テストシナリオを実行します。ここで、「テストデータを選択」というウィンドウも表示されますので、今回で使うデータセットを必要に応じて選択して、実行すると、パラメータ値が順番に自動的に設定され、リクエストをループして複数回実行されます。

Apidogのテストシナリオには、Postmanのようなコレクションの制限がなく、全てのAPI、APICase及びカスタムリクエストをもテストステップとして追加することができます。この機能により、APIテストの自動化がより自由に行うことができます。また、テスト用のデータセットを利用する場合、Apidogで直感的なUIでテストを入れたり、既存のファイルからインポートしたりすることもできますので、より便利で柔軟なソシューションになると思います。

まとめ

APIテストにおいて、パラメータ値を変更してリクエストを複数回実行することは非常に重要です。これにより、APIの入力値の妥当性確認、異なるユースケースのテスト、複雑な条件の確認、レスポンスの妥当性確認、異常系テスト、パフォーマンステストなどが可能になります。Postmanでは、テストデータをJSONファイルとして作成し、コレクション実行時にそのデータをインポートすることで、パラメータ値を変更してリクエストをループさせることができます。

一方、Apidogではデータセットという機能を使うことで、より簡単にパラメータ値を変更してリクエストをループさせることができます。Apidogではテストデータの作成や管理が直感的なUIで行えるため、柔軟性が高く便利です。また、Apidogは包括的なAPIソリューションを提供しており、API設計、ドキュメンテーション、テスト自動化、モックサーバーなど、APIライフサイクル全体をサポートしています。APIテストの自動化だけでなく、APIの品質向上全般に役立つツールといえます。

APIテストにおいて、パラメータ値を変更してリクエストをループさせる機能は非常に重要です。PostmanとApidogはそれぞれ異なる方法でこの機能を提供しており、ユーザーはニーズに合わせて使い分けることができます。