これはPostman Advent Calendar 2024の19日目の記事。本記事では、知っておくと便利なPostmanの画面上にあるメニューアイコンについて紹介します。
Postmanの画面構成
Postmanの画面は以下の4つのエリアでから構成されています。
・ヘッダー
・サイドバー
・ワークベンチ
・右サイドバー
・フッター
ヘッダー
ヘッダーでは、ワークスペースの作成、レポートの確認、APIネットワークでのAPIの検索、通知の確認、設定等を行うことができます。
🔸ホーム - ユーサーのホームページを表示。
🔸ワークスペース - ワークスペースの検索、新規ワークスペースの作成ができます。
🔸API ネットワーク - 一般に公開されているAPIの検索ができます。Salesforce, Paypal、Stripe等のAPIをフォークして簡単に利用できます。
🔸招待 - 管理者であれば、特定のワークスペースに他のユーザを招待できます。
🔸上図①(設定) - Postmanの様々な設定ができます。UIの日本語設定、自動保存の設定もここからできます。
🔸上図②(通知) - チームのアクティビティー、Postmanからの通知、プルリクエスト等の通知を確認できます。
🔸上図③(ユーザーのアバター) - ユーザプロファイルの確認、設定ができます。
サイドバー
サイドバーでは、Postmanのコレクション、環境、フロー等の各コンポーネントへのアクセスが可能です。
サイドバーへのコンポーネントの追加
初期設定ではPostmanの全てのコンポーネントはサイドバーに表示されていません。表示するコンポーネントを追加するには、以下のボタンを押し、サイドバー設定画面を表示します。
サイドバーを設定でコンポーネントの表示をon/offします。
ワークベンチ
コレクション、API、その他のコンポーネントのいずれで作業する場合も、Postmanワークベンチは作業の大部分を行う場所になります。タブで作業を整理し、右サイドバーでドキュメントなどのツールにアクセスできます。また、環境セレクタと変数ペインで変数を管理できます。
右サイドバー
右サイドバーでは、選択しているコンポーネントに応じて、ドキュメント、コメント、コードスニペット等のツールにアクセスすることが可能です。
🔸①ドキュメント - 各APIリクエストのドキュメントを確認できます。
🔸② コメント - 各APIリクエスト、コレクションに対してコメントを残すことができます。チームを構成している場合、チームメンバーとコメントを共有することができます。
🔸③ コードスニペット - 様々な言語でのコードを生成することができます。
🔸④ 関連リクエスト - 公開APIに対するリクエストを実行した場合に、APIネットワーク上にある当該リクエストに関連したものを表示します。
🔸⑤ インフォメーション - コレクションID、作成日時等の詳細情報を確認できます。
🔸⑥ 変更履歴 - ユーザ、またはチームメンバーが行った変更箇所、変更日時の確認ができます。
🔸⑦ プルリクエスト - コンポーネント毎のプルリクエストの一覧を確認できます。
🔸⑧ フォーク - 各コンポーネントのフォークしているアイテムを確認できます。
フッター
フッターでは、同期の状態や、コンソール等を確認できます。
🔸① サイドバー非表示 - サイドバーの表示、非表示を切り替えられます。
🔸② 同期状況 - Postmanサーバへの接続状況、データの同期状況を確認できます。
🔸③ 検索と置換 - 文字列の検索、および置き換えを行うことができます。
🔸④ コンソール - Postmanを使って送受信したリクエストの検証、デバックに利用できます。
🔸⑤ Postbot - AIアシスタントであるPostbotの起動。テストスクリプトの作成、レスポンスの可視化、デバック、利用方法に関する質問等、様々な質問をすることができます。
🔸⑥ ランナー - コレクションランナーを画面を開くことができます。
🔸⑦ リクエストのキャプチャー(ブラウザーアプリの場合） - HTTPトラフィックのキャプチャー機能を起動することができます。(Postman インターセプター拡張モジュールのインストールが必要です）
🔸⑦ プロキシの起動(デスクトップアプリの場合） - HTTPトラフィックのキャプチャーを行うプロキシを起動することができます。
🔸⑧ Postmanエージェントの選択(ブラウザーアプリのみ) - Postmanエージェントの選択ができます。
🔸⑨ Cookie - Cookieの参照、管理、および同期を行うことができます。
🔸⑩ Vault - ローカルのPostman Vaultへ保存している情報の確認、追加を行うことができます。
🔸⑪ ごみ箱 - 削除したコレクションのリカバリー、または完全削除を行うことができます。
🔸⑫ 画面表示切替え - 通常上下で表示されるリクエストとレスポンス画面を、左右に切り替えることができます。
🔸⑬ ヘルプ - Postmanのドキュメント、サポート等のリソースにアクセスすることができます。
以上、「知っていると便利なPostmanメニューアイコン」となります。少しでもみなさんのPostman利用が便利になればと思い共有させていただきました。