MS_Postman

Postman

• TOP > インフラストラクチャ > 通信技術 > HTTP > WebAPI
  • cURLコマンド
  • Postman

概要

WebAPI 開発用のツール。

移行メモ: 元ページは「WebAPI 開発用のツール」の 1 行のみであった。 作者の位置付け（cURLコマンド と並ぶ WebAPI の検証ツール）を 保ちつつ、最低限の内容を補った。

cURLコマンド が CLI であるのに対し、Postman は GUI である。
リクエストを保存・共有でき、チームでの API 開発に向く。

詳細

主な機能

機能	内容
リクエストの作成・保存	メソッド／URL／ヘッダ／ボディを GUI で組み立てて保存する
コレクション	関連するリクエストをまとめる。エクスポートして共有できる
環境変数	{{baseUrl}} のように変数化し、開発／検証／本番を切り替える
認証	Basic、Bearer、OAuth 2.0などの取得・付与を支援する
テスト スクリプト	JavaScript でレスポンスを検証する（アサーション）
Newman	コレクションを CLI から実行する。CI に組み込める
インポート	Swagger (OpenAPI) 定義や cURL コマンドから取り込める

OAuth 2.0の検証に使う

WebAPIの認証 の検証では、 Postman の Authorization タブで OAuth 2.0 を選び、 認可エンドポイント／トークン エンドポイント／client_id などを設定すると、 ブラウザでの同意まで含めてトークンを取得できる。 取得したトークンはそのまま後続のリクエストに付与される。

補足: リダイレクト URI には https://oauth.pstmn.io/v1/callback（Postman 既定のコールバック）を 認可サーバ側に登録しておく必要がある。

注意点

補足: 業務で使う場合の注意を挙げておく。

• 既定でクラウド同期される。 リクエストに本番の資格情報やトークンが含まれていると、 それが Postman のサーバに保存されうる。 秘匿値は環境変数の secret 型に入れるか、 ローカルのみで保持する運用にすること。
• 2023 年に Scratch Pad（オフライン利用）が縮小され、 基本的にアカウントとログインが前提の製品になっている。
• 社内ポリシー上クラウド同期が問題になる場合、 Insomnia、Bruno（ローカル ファイルで管理）、 VS Code の REST Client 拡張、 あるいは素直に cURLコマンド を使うといった代替がある。

参考

• WebAPI
• cURLコマンド
• Swagger (OpenAPI)
• Postman 公式サイト

---

Tags: 通信技術, .NET開発, .NET Core, .NET Standard, ASP.NET, ASP.NET Web API