Postmaのインタフェース（デスクトップアプリ版）

https://learning.postman.com/docs/getting-started/basics/navigating-postman/


Postman には、API プロジェクトの管理に役立つさまざまなツール、ビュー、コントロールが用意されています。このガイドは、Postman の主要なインターフェイス領域の概要を示しています。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/328136/f641162f-1808-37e8-3f38-5d2df62aa5df.png)

# ヘッダ(Header)

ヘッダーを使用すると、ワークスペースの作成、レポートへのアクセス、パブリック API ネットワークの探索、Postman での検索、同期ステータスと通知の表示、設定、アカウント、および[Postman プラン](https://learning.postman.com/docs/billing/buying/)へのアクセスが可能になります。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/328136/fcda3f83-8643-e497-c427-482dcc5c2e04.png)

+ ← → - ( [Postman デスクトップ アプリ](https://learning.postman.com/docs/getting-started/installation/installation-and-updates/)で利用可能) Postman 内でアクセスしたページを前後に移動します。
+ ホーム(Home)- 個人のホームページに移動します。このページには、最近アクセスしたワークスペースと、該当する場合は[チーム](https://learning.postman.com/docs/collaborating-in-postman/working-with-your-team/collaboration-overview/)のリソースへのリンクが含まれます。
+ ワークスペース(Workspaces)- ワークスペースを検索したり、最近アクセスしたワークスペースを表示したり、[新しいワークスペースを作成したりできます](https://learning.postman.com/docs/getting-started/first-steps/creating-your-first-workspace/)。
API ネットワーク(API Network)-[パブリック API](https://learning.postman.com/docs/getting-started/first-steps/exploring-public-api-network/) ネットワークを探索し、チームの[プライベート API ](https://learning.postman.com/docs/collaborating-in-postman/private-api-network/adding-private-network/)ネットワークにアクセスします。
+ 探索(Explore)- Postman のパブリック API、チーム、ワークスペース、コレクションを参照します。


![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/328136/84668b7e-710b-abae-c586-4aefac82b383.png)

+ <img width="20"  src="https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/328136/935d2fa6-c1cc-0584-4c2e-fc23ca811879.png"> Postman の検索- Postman のすべてのワークスペース、コレクション、リクエスト、API、フロー、チームを検索します。Postman での検索の詳細については、「[Postman の検索](https://learning.postman.com/docs/getting-started/basics/navigating-postman/#search-postman)」を参照してください。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/328136/09f10c9e-5355-7edd-85b3-63581fc970c8.png)

+ 招待(Invite)-ワークスペースの管理者ロールを持っている場合は、他のユーザーを共同作業に招待できます。

+ <img width="20"  src="https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/328136/a35782f1-a61a-fefe-14eb-9d02c2b00cfd.png">設定- Postman 設定およびその他の Postman リソースにアクセスします。

+ <img width="20"  src="https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/328136/4e83601f-2b4f-302b-6e32-f0e7b1d7bddb.png">通知- チームからの最近のアクティビティを表示し、Postman の更新に関する通知を受け取り、プル リクエスト、コメント アクティビティ、その他の重要な情報を確認します。
+ あなたのアバター- プロフィールの表示、アカウントと通知設定へのアクセス、アカウントのアクティブなすべてのセッションの表示、またはアカウントからのサインアウト。
+ チーム(Team)【有料プラン】 またはアップグレード【無料プラン】 -リソースの使用状況を表示し、請求ダッシュボードやその他のアカウント管理ツールにアクセスします。

# Postmanを検索

Postman で検索するには、ヘッダーで[Postman を検索]を選択し、検索語を入力します。キーボード ショートカット⌘+KまたはCtrl+Kを使用することもできます。検索範囲を変更するには、検索バーの左側にある範囲ドロップダウン リストを選択します。Postman、チーム、[プライベート API ネットワーク](https://learning.postman.com/docs/collaborating-in-postman/private-api-network/adding-private-network/#search-for-elements-in-the-network)、パブリック API ネットワークのすべてを検索できます。Workspaces、Collections、Teamsなど、検索する要素の種類を指定することもできます。

[チーム メンバーがコレクション](https://learning.postman.com/docs/collections/using-collections/#tagging-a-collection)、[API](https://learning.postman.com/docs/designing-and-developing-your-api/managing-apis/#tagging-apis)、[ワークスペース](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/managing-workspaces/#tagging-a-workspace)に追加したタグ名で検索できます([エンタープライズ プランのみ](https://www.postman.com/pricing))。タグ名で検索するには、ヘッダーで [ Postman を検索]を選択し、tag:tag-name形式を使用して検索を入力します。たとえば、API に「production」タグが付いている場合、「production」と入力すると、tag:production検索結果に API が表示されます。

:::note
サインアウトしたユーザーの場合、検索結果にはパブリック リソースのみが含まれます。
:::

検索結果のリストに探しているものが見つからない場合は、[すべての結果を表示]を選択して、すべての結果を 1 ページに表示します。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/328136/67994143-669b-31ed-2b26-e7bfde487bcd.png)


検索結果ページには、スコープと要素タイプがリストされます。これらのオプションを変更して、結果をさらにフィルタリングすることができます。

また、右側の[並べ替え]を使用して、 [最も関連性の高い] (デフォルト)、[最も多くのビュー]、または[最新]を選択して、結果を並べ替えることもできます。

要素のタイプに応じて、検索結果には異なる情報が含まれます。

+ ワークスペースの場合、検索結果にはワークスペースのタイプ、概要、公開者、公開日が表示されます。
+ コレクションの場合、検索結果にはワークスペースのタイプ、コレクションがフォークかどうか、誰が公開したか、いつ公開されたかが表示されます。
+ APIの場合、検索結果には API の名前と概要、API の所有者 (個人ユーザーまたはチーム)、およびワークスペース タイプが表示されます。
+ チームの場合、検索結果にはチームの名前と概要が表示されます。チーム名を選択すると、チームのプロフィールにリダイレクトされます。

# サイドバー(Sidebar)

Postman サイドバーでは、Postman の基本要素にアクセスできます。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/328136/dae13ab5-e6d0-9c1e-94c3-398cb2f8cbc3.png)

サイドバーの要素で使用できるタスク オプションを確認するには、要素の名前を選択し、その他のオプション アイコン を選択します その他のアクションアイコン 。タスクのオプションは、選択した要素のタイプによって異なります。

コレクション、コレクション内のフォルダーとリクエスト、および履歴内のリクエストの場合は、一度に複数の要素を選択できます。⌘またはCtrlを押したままにして、目的の要素を選択します。隣接する要素の場合は、Shiftを押したまま、目的の要素を選択します。コレクションとそのコンテンツについては、コピー、貼り付け、削除などのタスクに[キーボード ショートカット](https://learning.postman.com/docs/getting-started/installation/settings/#shortcuts)を使用することもできます。

サイドバーで「新規」を選択して、リクエスト、コレクション、API、およびその他の一般的な Postman 要素を作成できます。要素を選択してワークスペースに作成します。最も頻繁に使用する要素を固定することもできます。要素を固定するには、要素の上にマウスを置き、要素の固定アイコン を選択します <img width="20"  src="https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/328136/aaf81975-253d-0f9c-fe55-749ab1948b27.png"> 。要素の固定を解除するには、固定された要素の上にマウスを置き、要素の固定アイコン の選択を解除します 要素アイコンの固定を解除する <img width="20"  src="https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/328136/d710833d-487a-282a-8759-91da41f448eb.png">。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/328136/2a9cb7a3-05dc-949c-47e5-e569f9cb40d6.png)


[サイドバーを非表示にするには](https://learning.postman.com/docs/getting-started/basics/navigating-postman/#footer)、![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/328136/d9f57f8e-19d3-7bc9-dc24-bfbc2cd856e8.png)を非表示にする から[サイドバーを非表示] アイコンを選択する か、サイドバーの空の部分を右クリックして[サイドバーを折りたたむ]を選択します。

デフォルトでは、サイドバーはCollections、Environments、およびHistory以外の空の要素を非表示にします。[要素をサイドバーに追加] アイコンを選択して ワークスペース設定サイドバーアイコンに要素を追加する を開き、表示または非表示にするサイドバー要素を指定できます。サイドバーを右クリックすると、ラベルの表示/非表示、サイドバーの折りたたみ、サイドバーの構成を行うオプションが表示されます。

# 履歴(History)

行ったリクエストにアクセスするには、サイドバーの「履歴」を選択します。Postman にサインインすると、履歴がデバイス間で[同期されます](https://learning.postman.com/docs/getting-started/basics/syncing/)。

リクエストを選択すると、新しいタブで再度開きます。複数のリクエストを選択するには、⌘またはCtrlを押したままリクエストを選択します。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/328136/9965ec06-d4c3-1ef7-ac27-a07622f81e3d.png)


履歴には[収集の実行](https://learning.postman.com/docs/collections/running-collections/intro-to-collection-runs/)も含まれます。これらは実行の要約バージョンとして残り、単一のリクエストとして記録されません。

+ 追加アイコン+を選択して、リクエストをコレクションに保存します。
+ <img width="20"  src="https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/328136/262ecf03-f174-9823-7d4e-a99798c91765.png"> 履歴からリクエストを削除するには、削除アイコンを選択します 。
+ 「その他のアクション」アイコンを選択して その他のアクションアイコン 、リクエストのモニター、ドキュメント、モックサーバーの作成など、他のアクションにアクセスします。

:::note
[共有ワークスペース](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/creating-workspaces/)でリクエストを行うと、リクエスト履歴は自分には表示されますが、ワークスペース内の他のチーム メンバーには表示されません。
:::

**履歴をクリアする**

履歴からすべてのリクエストを削除するには、 その他のアクションアイコン 履歴検索バーの横にあるその他のアクション アイコンを選択し、 [すべてクリア]を選択します。

**回答を履歴に保存する**

リクエストの応答を履歴に保存するには、 その他のアクションアイコン 履歴検索バーの横にあるその他のアクション アイコンを選択し、[応答の保存]をオンにします。

:::note
[Collection Runner](https://learning.postman.com/docs/collections/running-collections/intro-to-collection-runs/)からのリクエストでは「レスポンスの保存」オプションを使用できません。
:::

# ワークベンチ(Workbench)

コレクション、API、または別の要素タイプを操作する場合、Postman ワークベンチで作業の大部分が行われます。[タブ](https://learning.postman.com/docs/getting-started/basics/navigating-postman/#tabs)を使用して作業を整理でき、[右側のサイドバー](https://learning.postman.com/docs/getting-started/basics/navigating-postman/#right-sidebar)からドキュメントなどの要素固有のツールにアクセスできます。[環境セレクターと環境クイックルックを使用すると](https://learning.postman.com/docs/getting-started/basics/navigating-postman/#environment-selector-and-environment-quick-look)、変数を管理できます。

**タブ**

タブを使用すると、リクエストを整理したり、リクエスト間で作業したりできます。

:::note
このセクションでは、Postman デスクトップ アプリでのタブの動作について説明します。デフォルトでは、Postman Web アプリのタブもこのように機能します。代わりにブラウザ タブを使用することを選択できます。これにより、開いている Postman 要素ごとに異なるタブを使用できるようになります。詳細については、「[Postman Web アプリのブラウザー タブ](https://learning.postman.com/docs/getting-started/basics/navigating-postman/#browser-tabs-in-the-postman-web-app)」を参照してください。
:::

**新しいタブを開く**

新しいタブを開くには、ワークベンチで+を選択します。

:::note
⌘+TまたはCtrl+Tを選択して新しいタブを開くこともできます。
:::

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/328136/d696f184-f9b5-f088-4a51-29045f28b7e1.png)

リクエストを開いて編集も送信も行わずに別のリクエストを開くと、最初のタブが 2 番目のタブに置き換えられます。タブがプレビュー モードの場合、タブは斜体で表示されます。

Postman がリクエストやその他のサイドバー項目を新しいタブで開くかどうかを設定できます。<img width="20"  src="https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/328136/ef8cacef-67cb-d0f0-e08e-2f7686fdf4b5.png">  ヘッダーの設定アイコンを選択し 、 [設定]を選択します。[ユーザー インターフェイス]で、[サイドバー項目を常に新しいタブで開く]を選択して、このオプションをオンまたはオフにします。

**変更の保存または破棄**

タブに未保存の変更がある場合、Postman はタブ名の横にドットを表示します。保存アイコン <img width="20"  src="https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/328136/d1a8e4a5-1bee-894a-bef3-d077742ce74d.png">[保存]を選択して 変更を保存します。タブを閉じて変更を破棄するには、<img width="20"  src="https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/328136/21b601c5-7e14-d398-7ddf-40f79688b618.png">を選択し 、 [保存しない]閉じるアイコン を選択します。

**要素の名前変更とリンク**

要素の名前を変更するには、要素の名前を選択し、新しい名前を入力します。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/328136/46478c4a-978a-85d9-6922-914f5320fae7.png)


要素へのリンクをコピーするには、ワークベンチで要素の名前の上にマウスを移動して、リンク アイコン を表示します リンクアイコン 。リンク アイコンを選択して、要素の URL をクリップボードにコピーします。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/328136/39ab6439-a221-8c95-e22e-3e496d05f622.png)


要素が誰もアクセスできない個人ワークスペースにある場合、リンク アイコンを選択するとポップアップ ウィンドウが表示されます。ポップアップ ウィンドウを使用すると、リンクを共有する前にユーザーを個人ワークスペースに招待できます。個人ワークスペースに人を招待するには、「人を招待」を選択します。ワークスペースでの共同作業にユーザーを招待する方法の詳細については、「[ワークスペースの共有](https://learning.postman.com/docs/collaborating-in-postman/using-workspaces/managing-workspaces/#sharing-workspaces) 」を参照してください。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/328136/9d569fb2-d377-b514-1e0e-0ff945ce469e.png)

**競合の表示**

あなたまたは共同作業者が別のタブまたはワークスペースでタブの内容を変更すると、タブは競合を警告します。Postman は、競合が発生した場合は解決するように求めます。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/328136/0dbe13c4-3c36-2a66-d1da-c3e03bbba4e0.png)


**タブの管理**

同時に多くのタブを開くことができます。開いているタブを並べ替えるには、タブを選択して希望の順序にドラッグします。

開いているタブを管理したり、最近閉じたタブにアクセスするには、「その他のアクション」アイコンを選択して、 その他のアクションアイコン アクション オプションを含むメニューを開きます。

+ 最近閉じたタブ- 最近閉じたタブを表示します。いずれかを選択して再度開きます。
+ 選択したタブを複製- ( [Postman デスクトップ アプリ](https://learning.postman.com/docs/getting-started/installation/installation-and-updates/)で利用可能)現在のタブを複製します。これではリクエストのコピーは作成されないため、タブを複製すると、行った編集は元のリクエストに反映されます。
+ 選択したタブを閉じる- 現在のタブを閉じます。タブに未保存の変更がある場合、Postman は閉じる前に保存するかどうかを尋ねます。
+ 選択したタブを強制的に閉じる- 変更を保存せずに現在のタブを閉じます。
+ 選択したタブを除くすべてを閉じる- 作業中のタブを除くすべてのタブを閉じます。
+ すべてのタブを閉じる- すべてのタブを閉じます。タブに未保存の変更が含まれている場合、Postman は閉じる前に保存するかどうかを尋ねます。
+ すべてのタブを強制的に閉じる- 変更を保存せずにすべてのタブを閉じます。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/328136/eb1be983-be77-90a6-9ced-3db367517f6b.png)


開いているタブを管理したり、既存のタブを右クリックして新しいタブを開くこともできます。

:::note
未保存のタブを閉じる。変更が含まれたタブを閉じるときに、Postman が保存するかどうかを設定できます。設定アイコン ヘッダーの設定アイコンを選択し 、 [設定]を選択します。[ユーザー インターフェイス]で、[未保存のタブを閉じるときに常に確認する]を選択して、このオプションをオンまたはオフにします。
:::

多数のタブを開いている場合、それらのタブがタブ バーの領域からはみ出す可能性があります。表示可能領域の外側にあるタブに移動するには、タブ バーの横にある矢印を選択します。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/328136/8335610d-c595-bb38-7403-80395b153e21.png)


**Postman Web アプリのブラウザ タブ**

デフォルトでは、Postman Web アプリは Postman デスクトップ アプリと同様にアプリ内タブを使用します。必要に応じて、代わりにブラウザのタブを使用することを選択できます。この設定をオンにすると、メイン作業領域には一度に 1 つのコレクション概要またはリクエストのみが存在し、新しいブラウザー タブでより多くの Postman 要素を開くことができます。これにより、複数のワークスペースで作業したり、同じワークスペース内で異なる環境を使用したりすることができます。

リクエストの変更を保存した場合、新しい要素を選択すると、Postman はその要素をメイン作業領域で開きます。リクエストに保存されていない変更がある場合、Postman は変更を保存するか破棄するかを尋ねます。

新しいブラウザー タブでワークスペース、環境、またはリクエストを開くには、 ⌘+ShiftまたはCtrl+Shiftを押したまま、開きたい要素を選択します。

新しいブラウザー タブでアプリ内リンクを開くには、 ⌘またはCtrlを押したまま、開きたいリンクを選択します。

<img width="20"  src="https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/328136/ca13c06e-a7c8-ee54-65cd-f5b23d0115b1.png"> Postman Web アプリでこの動作をオンまたはオフにするには、ヘッダーの設定アイコンを選択し 、 [ユーザー インターフェイス]セクションで[タブの削除]を選択します。

**右サイドバー**

右側のサイドバーでは、選択した Postman 要素の種類に基づいて、ドキュメント、コメント、コード スニペット、リクエスト情報などのその他のツールにアクセスできます。

![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/328136/cb2285be-6893-abc4-ddd2-913f7a0c92d8.png)



|ツール|	利用可能場所|説明 |
|:-----------------|:--------------------|:------------------------|
|ドキュメンテーション<img width="20" src="https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/328136/f3e3e0af-f1d0-74d4-bade-19848f4ffd59.png">|リクエスト	|特定のリクエストの[ドキュメント](https://learning.postman.com/docs/publishing-your-api/document-a-collection/)を参照してください。|
|コメント コメントアイコン<img width="20"  src="https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/328136/54ab50ed-b4d5-404b-fecb-8f9f7acefbb9.png">|コレクション、リクエスト、API|リクエストまたは API の特定の部分について[コメント](https://learning.postman.com/docs/collaborating-in-postman/working-with-your-team/discussing-your-work/)を残します。|
|コード コードスニペットアイコン![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/328136/9adc3bbd-85f2-e52e-3e35-188fd02aeacc.png)|リクエスト、API、履歴	|[他のアプリで使用できるコード スニペット](https://learning.postman.com/docs/sending-requests/generate-code-snippets/)をさまざまな言語およびフレームワークで生成します。|
|ライブコレクション ライブコレクションアイコン![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/328136/f6db379c-251a-7ebf-2db2-32dfecdc3046.png)|コレクション	|[Live Collections](https://learning.postman.com/docs/collections/live-collections/live-collections-overview/) を使用して、アプリケーションに基づいてコレクションを最新の状態に保ちます。|
|関連コレクション 関連コレクションアイコン![image.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/328136/7b4a7d1a-35fd-7828-905d-47f2a6528f68.png)|リクエスト、履歴	|リクエストと同じベース URL を共有し、API ドキュメントを含む[パブリック API ネットワーク](https://learning.postman.com/docs/getting-started/first-steps/exploring-public-api-network/)からのパブリック コレクションを表示します。|