設計とビルド

Native Git

コード、コレクション、仕様、テストを同じリポジトリで管理できます。ローカルでの作業を基本とし、コードと同じ手順でリリースできます。

PostmanデスクトップアプリのLocal Viewを表示しています。bookmarkAppのGitリポジトリのファイルツリーには、serverディレクトリやsrcディレクトリと並んで.postmanフォルダーとpostmanフォルダーが表示されています。ステータスバーにはmainブランチが表示され、クラウドからプルする操作とクラウドへプッシュする操作も確認できます。

世界中の導入企業

PayPal社のロゴ
Moneris社のロゴ
Autodesk社のロゴ
Kroger社のロゴ
Cover Genius社のロゴ
Siemens社のロゴ
ZEISS社のロゴ
PayPal社のロゴ
Moneris社のロゴ
Autodesk社のロゴ
Kroger社のロゴ
Cover Genius社のロゴ
Siemens社のロゴ

API開発に使うコレクションや仕様を、コードと同じリポジトリで管理できます。

Postman Native Gitを使うと、APIのコレクション、環境、仕様、テストを、対象のコードと同じGitリポジトリにファイルとして保存できます。Gitでブランチを作成してレビューし、Postman CLIを使ってCIで実行できます。共有する準備ができたら、Postmanの共有ワークスペースにプッシュできます。

コレクションと仕様をコードとともに管理できます

リクエスト、仕様、環境ごとに1つのYAMLファイルを作成し、リポジトリ内の/postmanに保存します。普段レビューしているファイルと同じように、行単位で差分を確認できます。

今のGitワークフローをそのまま使えます

通常のファイルなので、使い慣れたGitツールでブランチを作成し、差分の確認やレビューができます。Postmanが既存のGitツールに取って代わることはありません。

CIでテストし、マージ時に公開できます

Postman CLIを使ってパイプライン内でコレクションを実行し、ブランチのマージ時にCloud Viewへ公開できます。

Postman AIはコレクションに加えて、コードも読み取ります

コレクションがサービスのコードと同じリポジトリにファイルとして保存されるため、Postman AIは両方を読み取れます。テストで何を見落としているか尋ねると、仕様ではなく、ルートハンドラーの実装をもとに回答します。

PostmanデスクトップアプリのLocal Viewを表示しています。bookmarkAppのGitリポジトリのファイルツリーには、コレクションと環境を格納するpostmanフォルダーが、ソースコードを格納するserverディレクトリやsrcディレクトリと並んで表示されています。
Ask Postman AI

機能

コードベースをPostmanに合わせるのではなく、Postmanをコードベースに取り入れられます

コレクション、仕様、環境を、今使っているリポジトリでコードとともにバージョン管理できます。実行には既存のパイプラインを使い、チームには自分でプッシュすると決めたタイミングで共有できます。

1つのプルリクエストを表すアイコン

コードとAPIのコントラクト(契約)を1つのプルリクエストで変更できます

ハンドラーと対応するコレクションを同じコミットで変更できます。レビュー担当者はAPIの変更とコードの変更を並べて確認でき、両方を必ず一緒にリリースできます。

CIパイプラインのアイコン

CIでリント、テスト、公開できます

Postman CLIは、ガバナンスルールに照らして仕様をリントし、違反があればビルドを失敗させます。機能テストとパフォーマンステストのスイートを実行し、マージ時に公開します。

Cloud Viewのアイコン

チームの他のメンバーはCloud Viewで閲覧できます

準備ができたらプッシュすることで、チームの他のメンバーはPostman上で読み取り専用の内容を閲覧できます。リポジトリへのアクセスやローカルへのクローンは必要ありません。

Gitプロバイダーのアイコン

どのGitプロバイダーのリポジトリでも使えます

GitHub、GitLab、Bitbucketに対応し、クラウド型かセルフホスト型か、公開か非公開かを問わず、Postmanを既存のリポジトリに接続できます。

モノレポのアイコン

モノレポにも対応しています

リポジトリのルートを接続し、各サービスのコレクションと環境を1つの.postman/resources.yamlにまとめて登録できます。

さまざまな環境で編集できることを表すアイコン

普段の作業環境で編集できます

IDEでも、Postmanでも、Agent Modeでもコレクションを編集できます。どの方法でも、編集するのはディスク上の同じYAMLファイルです。

すべてのプランで利用できることを表すアイコン

Freeプランを含むすべてのプランで利用できます

Native Git、無制限のワークスペース、非公開リポジトリは、有料アドオンを追加せずに利用できます。Gitを通じた共同作業に費用はかかりません。

Postman Native Gitに関するよくある質問

Postman Native Gitとは何ですか?

Postman Native Gitを使うと、APIのコレクション、環境、仕様、テストを、対象のコードと同じGitリポジトリにファイルとして保存できます。ローカルのGitリポジトリで開発を進め、共有する準備ができたときにだけPostman Cloudに同期します。Local Viewでは、コレクション、環境、仕様をコードとともに管理できます。Cloud Viewでは、チームが内容を確認し、信頼して利用できる共有バージョンとして提供されます。


Native Gitを使うには何が必要ですか?

Native GitはPostman desktop appで利用できます。Webアプリでは利用できません。また、APIのコードを含むローカルのプロジェクトフォルダーと、ワークスペースの作成先となるPostmanチーム(またはチーム外でワークスペースを作成する権限)が必要です。


FreeプランでNative Gitを利用できますか?

はい。Native Gitは、Freeを含むすべてのPostmanプランで利用できます。プランの比較は、Postmanの料金プランをご覧ください。


Native GitはどのGitプロバイダーに対応していますか?

Native GitはGitHub、GitLab、Bitbucketに対応しています。クラウド型とセルフホスト型のどちらでも、パブリックリポジトリとプライベートリポジトリを利用できます。


Native Gitはリポジトリ内のどこにファイルを保存しますか?

Native Gitは、リクエスト、仕様、環境ごとに1つのYAMLファイルをpostmanディレクトリ内に作成し、.postman/resources.yamlマニフェストに登録します。コレクションは単一のファイルではなく、小さなファイルをまとめたフォルダーとして保存されるため、差分を見ると、どのリクエストが変更されたかを正確に把握できます。変更していないファイルの内容は、そのまま保持されます。モノレポでは、リポジトリのルートを接続し、すべてのサービスのリソースを1つのマニフェストに登録します。

orders-service/
  .postman/
    resources.yaml
  postman/
    collections/
      orders api/
        list orders.request.yaml
        create order.request.yaml
    environments/
      staging.yaml
  src/

PostmanはGitクライアントの代わりになりますか?

いいえ。ブランチの作成、差分の確認、レビュー、コミットは、普段使っているターミナル、IDE、GitホスティングサービスでGitを使って行います。Postmanがこれらの操作を代わりに行うことはありません。共有する準備ができたら、Postman Cloudに同期します。


CI/CDでNative Gitの操作を自動化するにはどうすればよいですか?

Postman CLIを使用します。プルリクエスト時にpostman workspace lintを実行し、マージ後にpostman workspace pushを実行して、ローカルファイルをクラウドのワークスペースに同期します。パイプラインの認証には、シークレットとして保存したPostman APIキーを使用してください。CIからのプッシュは、そのキーを所有するアカウントによる操作として記録されます。詳しい設定手順は、Native GitのCI/CDガイドをご覧ください。


どの種類のリクエストをGitで管理できますか?

Native Gitは、REST、SOAP、GraphQL、gRPC、WebSocket、Socket.IO、MQTT、SSE、MCP、AIのリクエストを、使用する環境や仕様とともに、リポジトリ内にファイルとして保存します。


APIの作業内容は、いつPostman Cloudに反映されますか?

プッシュしたときにだけ反映されます。コレクション、仕様、環境はリポジトリ内にファイルとして保存され、アプリからプッシュするか、CIでpostman workspace pushを実行すると、Postman Cloudに反映されます。


コレクションの実行回数に制限はありますか?

いいえ。Freeを含むすべてのプランで、ローカルモードでのコレクションの実行回数に制限はありません。


シークレットをGitに保存しないようにするにはどうすればよいですか?

環境のローカル値はPostmanアプリ内に保持し、共有値のみをGitにコミットしてください。シークレットはリポジトリにコミットせず、Postman Vault、または1Password、AWS Secrets Manager、Azure Key Vault、HashiCorp Vaultなどの連携先のVaultから参照してください。


NewmanでNative Gitのコレクションを実行できますか?

いいえ。Native Gitはv3のYAML形式のコレクションを使用しますが、Newmanがサポートするのはv2.1のJSON形式のみです。Native GitのコレクションはPostman CLIで実行してください。旧形式のコレクションをv3に変換するには、postman collection migrateを使用します。


お使いのリポジトリでNative Gitを活用する方法をご紹介します。

Native Gitは、リポジトリの接続、コレクションや仕様と対象コードのバージョン管理、既存のパイプラインでの実行を支援します。こちらのフォームより、お気軽にご相談ください。