はじめに
Web APIの開発や利用において、避けては通れないのが動作確認です。
「このAPIにこのパラメータを送ったら、どんなレスポンスが返ってくるだろう?」
「エラー時の挙動はどうなっているだろう?」
こういった確認作業を、ブラウザのアドレスバーやcurlコマンドだけで行うのは大変ですよね。そこで登場するのが Postman です。
この記事では、世界中の開発者に愛されているAPI開発プラットフォーム「Postman」の基本的な使い方から、開発効率を劇的に向上させる現場レベルの活用術までを解説します。
1. Postmanとは?
Postmanは、API(Application Programming Interface)を簡単にテスト、文書化、共有できるプラットフォームです。
元々はシンプルなChrome拡張機能として始まりましたが、現在はMac/Windows/Linux用のスタンドアロンアプリとして、非常に多機能なツールへと進化しています。
主な機能
- APIリクエストの送信: 直感的なGUIでHTTPリクエストを作成・送信できます。
- レスポンスの確認: JSONやXMLなどのレスポンスを綺麗に整形して表示してくれます。
- コレクション(Collections): 複数のリクエストをフォルダ分けして保存・整理できます。
- 環境変数(Environments): 開発環境、ステージング環境、本番環境などでURLやトークンを切り替えられます。
- モックサーバー: バックエンドが完成していなくても、APIの挙動をシミュレートできます。
- 自動テスト: JavaScriptを使って、レスポンスの正しさを自動的に検証できます。
2. 基本的な使い方:リクエストを送ってみよう
まずは基本中の基本、HTTPリクエストを送ってみましょう。
ここでは、無料で使えるテスト用API JSONPlaceholder を使って解説します。
GETリクエスト
特定のデータを取得するリクエストです。
-
New Request ボタン(または
+タブ)をクリックして新しいタブを開きます。 - HTTPメソッドが
GETになっていることを確認します(デフォルトでGETのはずです)。 - URL入力欄に
https://jsonplaceholder.typicode.com/posts/1と入力します。 - Send ボタンをクリックします。
すると、画面下の「Response」エリアに、IDが1の記事データがJSON形式で綺麗に表示されます。
{
"userId": 1,
"id": 1,
"title": "sunt aut facere repellat provident occaecati excepturi optio reprehenderit",
"body": "quia et suscipit..."
}
ステータスコードが 200 OK になっていることや、応答時間(Time)、サイズ(Size)も一目で確認できますね。
POSTリクエスト
データを送信・登録するリクエストです。
- HTTPメソッドを
POSTに変更します。 - URLに
https://jsonplaceholder.typicode.com/postsと入力します。 - Body タブをクリックし、raw を選択します。
- 右側のプルダウンで JSON を選択します。
- 送信したいデータをJSON形式で入力します。
{
"title": "Postmanのテスト",
"body": "これはPostmanから送信された記事です。",
"userId": 1
}
- Send ボタンをクリックします。
ステータスコードが 201 Created になり、作成されたデータ(IDが付与されたもの)が返ってくれば成功です。
3. リクエストの整理:Collections(コレクション)
リクエストを毎回手入力するのは面倒ですよね。よく使うリクエストは「コレクション」として保存しましょう。
コレクションの作成
- 左サイドバーの Collections をクリックします。
- + ボタン(または Create Collection)をクリックします。
- 名前(例:
JSONPlaceholder API)を入力します。
リクエストの保存
先ほど作成したGETリクエストのタブに戻り、保存ボタン(フロッピーディスクのアイコンまたは Ctrl/Cmd + S)を押します。
保存先に先ほど作ったコレクションを指定すればOKです。
これで、次回からはサイドバーからクリックするだけで同じリクエストを呼び出せます。
「User系」「Post系」のようにフォルダを作って階層構造にすることも可能です。
4. 環境の切り替え:Environments(環境変数)
開発現場では、「ローカル環境」「検証環境」「本番環境」でAPIのドメイン(Base URL)や認証トークンが異なることがよくあります。
これを毎回書き換えるのは事故の元です。Environments を使ってスマートに管理しましょう。
環境変数の設定
- 右上の Environment quick look(目のアイコン)の隣にあるプルダウンから「Environments」を選択、または左サイドバーの「Environments」から作成します。
-
Local,Stagingなどの名前で環境を作成します。 - 変数(Variable)を追加します。
- Variable:
base_url - Initial Value / Current Value:
http://localhost:3000(Local用) - Variable:
base_url - Initial Value / Current Value:
https://api.staging.example.com(Staging用)
- Variable:
環境変数の使用
リクエストのURLで、変数を二重波括弧 {{ }} で囲んで使用します。
{{base_url}}/users
右上のプルダウンで環境を切り替えるだけで、送信先の {{base_url}} が自動的に差し替わります。
APIキーやトークンも変数化しておけば、コード(リクエスト設定)に直接書かなくて済むのでセキュリティ的にも安心です。
5. 一歩進んだ活用術
ここからは、開発効率をさらに上げる機能を紹介します。
APIテストの自動化(Tests)
「正常に動いているか」を目視で確認するのは疲れます。Postmanにはテストスクリプトを書く機能があります。
Tests タブにJavaScriptを書くことで、レスポンスが期待通りか自動チェックできます。
右側のスニペット集をクリックするだけでコードが挿入されるので、JSが得意でなくても大丈夫です。
よく使うテストの例
ステータスコードが200であることを確認
pm.test("Status code is 200", function () {
pm.response.to.have.status(200);
});
JSONの特定のフィールドをチェック
pm.test("User name is Leanne Graham", function () {
var jsonData = pm.response.json();
pm.expect(jsonData.name).to.eql("Leanne Graham");
});
リクエストを送ると、Test Results タブにテスト結果が「PASS/FAIL」で表示されます。
モックサーバー(Mock Servers)
フロントエンド開発をしている時、「バックエンドのAPIがまだできていないから作業が進まない…」という経験はありませんか?
Postmanのモックサーバー機能を使えば、APIの仕様(リクエストと期待されるレスポンス) を定義するだけで、仮のAPIエンドポイントを発行できます。
- コレクションを作成し、リクエストと「Example(レスポンス例)」を保存します。
- コレクションメニューから Mock collection を選択します。
- 公開URLが発行されるので、フロントエンドからはそのURLを叩くだけです。
これにより、バックエンドの実装を待たずにフロントエンド開発を並行して進めることができます。
おわりに
Postmanは単なる「HTTPクライアント」にとどまらず、開発ワークフローを支える強力なツールです。
今回紹介した機能以外にも、
- Monitors: 定期的にAPIを実行して死活監視する
- Documentation: コレクションからAPIドキュメントを自動生成する
- Postman CLI / Newman: CI/CDパイプラインにPostmanのテストを組み込む
など、奥深い機能がたくさんあります。
まずは「コレクション」と「環境変数」を使いこなして、快適なAPI開発ライフをスタートさせてください!