Postmanの導入

はじめに

AWS上に構築したREST APIの動作確認にPostmanを利用しています。
久しぶりに利用すると使い方を忘れているため、導入用の簡単な手順になります。

動作確認環境

• REST APIは、AWS APIGateway＋Lambdaで構築。
• APIGatewayの認証方法はIAMを指定。
• Postmanツールが動作するローカル環境は、Windows。

前提条件

• APIGatewayを実行可能な権限を持つ、AWSアクセスキー/シークレットキーが手元にあること。
  • 無い場合、自身で発行するか組織の管理者に発行してもらうこと。
• Postmanのアカウントは作成せず、未ログインで利用。

インストール方法

1. 下記サイトから、Windows版をインストール。
   https://www.postman.com/downloads/
2. インストール後、以下のUIが起動すればOK。
   

Postmanにテスト用APIを作成

① 環境変数の追加

開発やステージング環境など複数の環境を扱うために、環境変数を定義する。

1. 右上のEnvironmentのマークをクリックし、表示されたダイアログでAddを選択。
   

2. 環境名はDev（任意）とし、以下の環境変数を追加。
   入力が完了したらSaveを選択し保存する。

   Variable	Initial Value	補足
   BASE_URL	https://xxx	APIのURLのPrefix
   AWS_ACCESS_KEY_ID	※前提条件で取得したキーを指定
   AWS_SECRET_ACCESS_KEY	※前提条件で取得したキーを指定

3. 環境の新規作成が完了したため、EnvironmentでDevを指定する。
   同様の手順で、Stg/Prdなどの環境を個別に作成し、切り替えて利用することになる。
   

② コレクションの作成

Postmanはコレクションという単位でまとまったAPIの呼び出しを管理できる。
今回は、UserAPIコレクションを作成する。

③ APIリクエスト定義の作成

1. ②で作成したコレクションから、Add Requestを選択。
   

2. タイトルを入力する。ここでは、ユーザー情報の取得とする。後で見て分かりやすい名前にすること。

3. APIの定義に従ってURLを入力する。
   今回のテスト環境では、ユーザー一覧からユーザーIDを指定し、ユーザー情報を取得するAPIとした。

   {{BASE_URL}}/users/123
   

   • {{}}で囲むことで、①で追加した環境変数を参照できる。
   • 123は、取得対象のユーザーID

4. 現時点でのリクエスト定義の状態
   

5. AWS IAM認証のためのリクエストヘッダを追加する。
   AuthrizationからAWS Signatureを選択する。
   

6. ①で追加した環境変数を指定し、Saveを選択する。
   

APIリクエストを実行する

上記 ①～③で準備は完了したため、Sendを選択し、実際にリクエストを送信する。

青枠で囲った以下が確認できれば、正常動作が確認できたことになる。

• HTTPステータスが200であること
• 期待したレスポンスが返ってくること。

{
    "user_id": 123,
    "name": "tanaka",
    "address": "Tokyo shibuyaku."
}

最後に

Postmanを導入し、IAM認証を設定したREST APIに対して動作確認を行うことができました。
導入編のため、必要最小限の内容になっています。
今回作成したコレクションに他のAPIリクエスト定義も追加し、色々試してみましょう。今後の展開として、コレクション全体をまとめて自動実行することや、リクエスト結果をテストすることも可能です。