Postman(ポストマン)でAPIをテストする基礎

Postmanを使えば、コードを一切書かずにAPIへ実際のリクエストを送り、返ってくる内容をそのまま確認できます。

  1. 新しいリクエストを作成する

    左上のNewボタンから「HTTP Request」を選ぶと、新しいリクエストタブが開きます。

  2. メソッドとURLを指定する

    データを取得するときはGET、新しいデータを送るときはPOSTのように状況に合ったメソッドを選び、呼び出したいAPIのアドレスを入力します。

  3. リクエストを送信してレスポンスを確認する

    Sendボタンをクリックするとリクエストがサーバーに送られ、画面下部でステータスコードとJSON形式のレスポンス本文をその場で確認できます。

  4. パラメータとヘッダーを追加する

    Paramsタブでは検索条件などの追加情報を、Headersタブでは認証トークンなどの付加情報をリクエストに含めて送信できます。

  5. コレクションでリクエストをまとめて管理する

    よく使うリクエストをコレクションフォルダに保存しておくと、関連するAPIリクエストを体系的に整理でき、必要なときにすぐ呼び出せます。

  6. なぜ役立つのか

    コードを書かなくてもAPIが期待どおりに動作しているかを目で見て確認できるため、開発者以外のメンバーもAPIテストに参加しやすくなります。

レスポンスの見方:ステータスコードと本文

2xx系のステータスコードは概ね成功、4xx系は入力ミスや認証不足などリクエスト側の問題、5xx系はサーバー側の問題を示します。ステータスコードとJSON本文を合わせて見れば、何が正しく動き何が失敗しているのかがほぼ特定できます。

プロジェクトが大きくなるほどコレクションが重要になる理由

APIのエンドポイントが数個を超えてくると、整理されていない保存済みリクエストの一覧はあっという間に扱いづらくなります。関連するリクエストをコレクションにまとめ、フォルダで整理しておけば、テストの見通しがよくなり、新しく加わったメンバーも目的のリクエストをすぐに見つけられます。

よくある質問

Postmanは無料で使えますか?

ここで紹介した基本機能——リクエストの作成、レスポンスの確認、コレクションでの管理——は無料プランでも利用できます。有料プランではチーム用のワークスペースや高度な自動化機能などが追加されます。

Postmanは自動テストの代わりになりますか?

完全には代わりません。Postmanは手動での探索的なテストや簡単な確認には非常に便利で、コレクション内で簡単な自動テストスクリプトを実行することもできますが、本格的な自動テストのカバレッジには専用のテストフレームワークが別途必要になることが多いです。