Postman ドキュメントの概要

https://learning.postman.com/docs/introduction/overview/



# 始めましょう

Postman の使用を開始するには、「[はじめに](https://qiita.com/Keiji_otsubo/items/03657feed320bf103b89)」セクションを確認してください。

# 要求を送信する

Postman でリクエストを送信して、使用している API に接続できます。リクエストの送信方法の詳細については、「[ Postman で API リクエストを作成して送信し、](https://learning.postman.com/docs/sending-requests/requests/)[最初のリクエストを送信する方法を学習する」](https://learning.postman.com/docs/getting-started/first-steps/sending-the-first-request/)を参照してください。

# スクリプトを書く

Postman には、Node.js に基づく強力なランタイムがあり、リクエストやコレクションに動的な動作を追加できます。リクエストの実行前または後に実行するスクリプトを作成して、API テストを実行したり、動的パラメータを含むリクエストを構築したり、リクエスト間でデータを受け渡したりすることができます。スクリプトの詳細については、「[Postman でのスクリプト作成](https://learning.postman.com/docs/collections/collections-overview/)」を参照してください。

# コレクションを使用する

Postman コレクションは、保存されたリクエストのグループです。コレクションを使用して、リクエストを整理およびグループ化できます。その後、それらを一緒に実行できます。コレクションは、手動、スケジュールに基づいて、CI/CD パイプライン、または Webhook から実行できます。コレクションの詳細については、「 [Postman コレクションの作成、使用、実行 ](https://learning.postman.com/docs/collections/collections-overview/)」を参照してください。

# Postman Flowsを使用する

Postman Flows は、API ワークフローを作成するためのビジュアル ツールです。フローを使用すると、Postman ワークスペースでリクエストをチェーンし、データを処理し、現実世界のワークフローを作成できます。

Postman Flows の詳細については、「[Postman Flows を使用して API アプリケーションを視覚的に構築する](https://learning.postman.com/docs/postman-flows/gs/flows-overview/)」を参照してください。

# Postman CLI を使用する

Postman CLI は、Postman の安全なコマンドライン コンパニオンです。Postman CLI を使用すると、コレクションの実行、実行結果の Postman への送信、設定された API ガバナンスおよび API セキュリティ ルールに対する API 定義のチェックなどを行うことができます。

Postman CLI の詳細については、「[Postman のコマンドライン コンパニオンを探索する](https://learning.postman.com/docs/postman-cli/postman-cli-overview/)」を参照してください。

# Postman でコラボレーションする
Postman は、チーム内の[コラボレーション](https://www.postman.com/api-platform/api-collaboration/)を可能にし、強化するためのさまざまなツールを提供します。チーム ワークスペースを作成して、チーム メンバーが作業を共有し、API プロジェクトで共同作業できるようにすることができます。ユーザーは、特定のリクエスト、バージョン、API 定義やスクリプトのインラインなど、コレクションや API にコメントすることで、Postman で自分の作業について直接議論することもできます。

Postman でのコラボレーションの詳細については、「[Postman でチームを作成、参加、管理する](https://learning.postman.com/docs/collaborating-in-postman/working-with-your-team/collaboration-overview/)」を参照してください。


# APIの設計と開発

Postman は、API Builder を使用した[API ファースト開発をサポートします](https://www.postman.com/api-first/)。API Builder を使用して、Postman で API を設計します。API 定義は、API プロジェクトの信頼できる唯一の情報源として機能します。

API 開発およびテスト プロセスのさまざまな要素 (コレクション、ドキュメント、テスト、モニターなど) を API 定義に接続できます。Postman の API を Git リポジトリと同期することもできます。

API ファースト開発の詳細については、「[API Builder を使用して Postman で API を設計する](https://learning.postman.com/docs/designing-and-developing-your-api/the-api-workflow/)」を参照してください。

# API を文書化する

[ドキュメント](https://www.postman.com/api-platform/api-documentation/)は、コレクションまたは API の重要な部分です。適切なドキュメントは、コレクションを使用する人々がそのコレクションが何を行うのか、各リクエストがどのように機能するかを理解するのに役立ちます。また、包括的な API ドキュメントにより、消費者は利用可能なエンドポイントとそれらとの対話方法を知ることができます。

コレクションまたは API のドキュメントを生成すると、ユーザーは Postman でドキュメントを表示できるようになります。デフォルトでは、ドキュメントは非公開であるため、他のユーザーがアクセスするには、コレクションまたは API を共有する必要があります。パブリック API を作成している場合は、ドキュメントを公開して、Web ブラウザーを使用して誰でも公開できるようにすることができます。

API の文書化の詳細については、「[Postman で API を文書化する](https://learning.postman.com/docs/publishing-your-api/api-documentation-overview/)」を参照してください。

# APIを監視する

Postman モニターを使用すると、API の健全性とパフォーマンスを継続的に可視化できます。[モニター](https://www.postman.com/api-platform/api-monitoring/)を使用すると、API テスト スクリプトを実行し、複数のリクエストを連鎖させ、重要な API フローを検証できます。モニターは、設定したスケジュールに従って Postman クラウドからの一連のリクエストを実行します。モニターの使用方法の詳細については、「[Postman で API の健全性とパフォーマンスをモニターする](https://learning.postman.com/docs/monitoring-your-api/intro-monitors/)」を参照してください。

# API ガバナンスと API セキュリティ

[API ガバナンス](https://www.postman.com/api-platform/api-governance/)は、組織の API ランドスケープ全体で一貫した API 動作を促進する開発ルールを定義して適用する実践です。堅牢な[API セキュリティ](https://www.postman.com/api-platform/api-security/)体制とは、組織にセキュリティ最優先の API 動作を促進する開発ルールがあることを意味します。Postman API ガバナンスおよび Postman API セキュリティ機能は、API の不整合や弱点を特定し、考えられる修正や改善を推奨します。

Postman の API ガバナンスと API セキュリティ機能の詳細については、「[Postman の API ガバナンスと API セキュリティ](https://learning.postman.com/docs/api-governance/api-governance-overview/)」を参照してください。

# 管理

Postman は、初期セットアップから継続的なチームおよび計画の管理まで、チームのエクスペリエンスをカスタマイズするためのさまざまなオプションを提供します。チーム管理者は、チームのオンボーディング プロセスを合理化し、アクセス制御を管理し、最新バージョンの Postman でチームを最新の状態に保つことができます。

Postman チームの管理の詳細については、「[管理](https://learning.postman.com/docs/administration/managing-your-team/managing-your-team/)」セクションを参照してください。

# レポートを使用する

Postman は、チームが Postman をどのように使用しているかに関するデータを視覚化できるレポートを生成します。これらのレポートは、テスト、ドキュメント、監視範囲など、API の状態に関する洞察を提供します。また、パフォーマンスと SLA 遵守状況を追跡することもできます。

レポートの使用方法の詳細については、「[Postman で使用状況、セキュリティ、および請求に関するレポートを表示する](https://learning.postman.com/docs/reports/reports-overview/)」を参照してください。

 # 開発者リソース
 
[Postman を CI/CD ワークフローと統合している場合、または Postman API またはライブラリを使用して開発している場合は、 Postman 開発者リソース](https://learning.postman.com/docs/developer/resources-intro/)を確認してください。

# 統合
一般的なサードパーティ ソリューションとの統合により、Postman を API ワークフローに接続できます。統合を使用して、Postman と API 開発に依存する他のツールの間でデータを自動的に共有します。詳細については、「[Postman とサードパーティ ソリューションの統合](https://learning.postman.com/docs/integrations/intro-integrations/)」を参照してください。