【ぽすとまん】

Postman とは?

最終更新:
💡 APIに「お手紙」を送って返事を確認できる郵便屋さんツール

APIにリクエストを送り、返ってきた内容やステータスを確認できるツール。リクエストの保存・共有やテストにも使える。

📌 このページのポイント
Postman:APIへ送って確かめるリクエストを入力GET/products返事を確認200 OK商品一覧が返った?API送信先保存して再利用コレクション✓ 条件をテストコード・本文を検査
返事の例です。ステータスコードに加えて、期待する本文も確認します。
ひよこ ひよこ
Postmanって何に使うの?
ペンギン先生 ペンギン先生
APIにリクエストを送って、返事を確かめるツールだよ。画面でGETやPOSTなどのメソッド、URL、必要なヘッダーやデータを指定できる。フロントエンドの画面を作る前でも、APIの動きを確認できるんだ。
ひよこ ひよこ
返事のどこを見ればいい?
ペンギン先生 ペンギン先生
まずステータスコードと本文を見よう。たとえば200はHTTPでは成功を表すコードの一つだけれど、欲しいデータが返っているかも確認する。認証が必要なAPIでは、正しい認証情報やアクセス権も必要だよ。
ひよこ ひよこ
同じリクエストを何度も入力するの?
ペンギン先生 ペンギン先生
コレクションに保存できるよ。関連するリクエストをまとめて、フォルダーで整理したり、チームと共有したりする仕組みなんだ。
ひよこ ひよこ
自動でテストもできる?
ペンギン先生 ペンギン先生
レスポンスを受け取った後にJavaScriptのテストを実行できるよ。「ステータスが200か」「本文に必要な項目があるか」などを確かめる。コレクションをまとめて実行する方法や、CLIでCIに組み込む方法もあるよ。
ひよこ ひよこ
ワークスペースがあればGitはいらない?
ペンギン先生 ペンギン先生
ワークスペースは作業や共有の単位で、Gitそのものではないよ。現行の資料ではGitとの接続も案内されているし、コレクションをJSONとして書き出す方法もある。利用する版や保存・同期の設定に合わせて運用しよう。
ひよこ ひよこ
使う前に気を付けることは?
ペンギン先生 ペンギン先生
プランの対象機能や上限、チームへの共有範囲を確認しよう。APIキーなどの秘密情報を共有ファイルに入れないことも大切だよ。手軽に試せる一方、POSTやDELETEなどは実データを変更することがあるので、試す送信先を確かめよう。
ペンギン
まとめ:ざっくりこれだけ覚えればOK!
「Postman」って出てきたら「APIにリクエストを送って、返事を確かめるツール」と思えばだいたいOK!
📖 おまけ:英語の意味
「Postman」 = 英語で「郵便配達人」
💬 APIへのリクエストを手紙、レスポンスを返事と考えると覚えやすいね。これは機能を理解するためのたとえだよ。

参考資料

← 用語集にもどる