Intern

Postmanとは

今回はPostmanについて調べたことをまとめます。

Postman は、API を構築して利用するための API プラットフォームです。主にREST APIやGraphQL APIなどのHTTPベースのAPIを対象に利用されており、開発者やQAエンジニアにとって非常に便利なソフトウェアです。

Postmanの基本概要

提供元:
Postman Inc.(旧Postdot Technologies)

対応OS:
Windows / macOS / Linux / Web版あり

主な用途:
APIのリクエスト送信、レスポンス確認、テスト、自動化、ドキュメント作成など

使用プロトコル:
HTTP, HTTPS, WebSocketなど

Postmanの主な機能

APIリクエスト送信

  • エンドポイントに対して GET, POST, PUT, DELETE などのHTTPメソッドを指定してAPIを実行できます。
  • パラメータ、ヘッダー、ボディ(JSON, Formなど)を簡単に編集・送信できます。

レスポンスの確認

  • APIのレスポンスをJSON、XML、HTMLなどの形式で見やすく表示。
  • ステータスコード、ヘッダー、レスポンス時間なども確認可能。

APIテストの自動化

  • avaScriptベースでレスポンスに対する検証を書くことができます。
  • 例:ステータスコードが200か確認
pm.test("Status code is 200", function () {
    pm.response.to.have.status(200);
});Code language: JavaScript (javascript)

コレクション

  • 複数のAPIリクエストをグループ化し、順番に実行(Collection Runner)したり、CI/CDに組み込んだりできます。
  • 例えばログイン→データ取得→ログアウトのような一連の流れを自動化できます。

APIドキュメントの自動生成

  • リクエスト内容やレスポンスを元に、開発者向けのAPIドキュメントを生成・共有できます。

認証対応

  • Bearer Token, Basic認証, OAuth 2.0など、様々な認証方式に対応しています。

環境管理

  • 本番・開発・テスト環境などで使い分けられるよう、変数を設定できます。

まとめ

上記のことからPostmanを使うことで、API開発・検証・テストの効率が圧倒的に上がるということが分かりました。