[Postman]APIレスポンスの任意項目を変数に設定する

この記事は、tacoms Advent Calendar 2024の11日目です!
他メンバーのAdvent Calendarはこちらからご覧ください！👇
https://qiita.com/advent-calendar/2024/tacoms

概要

• 弊社ではプロダクトの性質上、外部APIを利用する機会が多いため、エンジニアが容易にAPIのデバッグが行えるよう、PostmanでAPIスキーマを管理しています。
• 今回は、便利機能の一部である「Post-response」を用いて、APIレスポンスの任意項目を変数に設定し、他のAPIスキーマで変数を使い回す方法を説明していきたいと思います。

Post-responseとは？

You can use post-response scripts in Postman to run JavaScript after a request runs. By including code in the Scripts > Post-response tab for a request, collection, or folder, you can write and validate API tests. You can also use post-response scripts for debugging your tests.

Postman の post-response スクリプトを使用して、リクエストの実行後に JavaScript を実行できます。リクエスト、コレクション、またはフォルダーの [スクリプト] > [Post-response] タブにコードを含めることで、API テストを記述して検証できます。また、テストのデバッグに post-response スクリプトを使用することもできます。

• レスポンス後に任意のスクリプトを実行できる機能。
• https://learning.postman.com/docs/tests-and-scripts/write-scripts/test-scripts/

実際に使ってみる

• 今回はトークン発行APIでレスポンスされたトークンを他のAPIで使い回す例で説明します。

1. Scripts > Post-responseに以下のスクリプトを記述する。

pm.test("Set Token", function () {
    const res = pm.response.json();
    pm.collectionVariables.set("token", res.access_token)
});

2. APIコールしてレスポンスデータをフック
   

3. Collections > Valiableに用意した変数にセットされる
   

4. 別のAPIで参照できる
   

まとめ

• 今回はPostmanの便利機能である「Post-response」を用いた使用例をご紹介しました。
• ちょっとした工夫で開発を効率よく行うことができるため、外部APIを使用する機会が多い方はぜひ使ってみてください。