NewmanとPostmanの違いとは？

NewmanとPostmanは競合するものではありません。これらは一つのワークフローを構成する二つの要素です。Postmanは、手動でリクエストを設計し、テストを記述し、APIを探索するためのデスクトップアプリケーションです。Newmanは、Postmanで作成したコレクションをGUIなしで実行するコマンドラインツールです。Postmanがワークショップだとすれば、Newmanは完成した作業をスケジュールに従って実行する機械です。

どちらを使用すべきか、という疑問から混乱が生じることがよくあります。正直な答えは、異なる段階で両方を使用する、です。グラフィカルインターフェースが作業を迅速にするため、Postmanで作成します。パイプラインはボタンをクリックできないため、Newmanで実行します。この記事では、両者の関係を正確に説明し、それぞれの役割を示し、NewmanをCI/CDパイプラインに組み込む方法を順を追って解説します。

Postmanとは

PostmanはグラフィカルなAPIプラットフォームです。デスクトップアプリとしてインストールし、リクエストを作成し、コレクションやフォルダに整理し、ベースURLやトークンなどの変数を保持する環境をアタッチします。各レスポンスの後、Postmanはリクエストの「Tests」タブで記述したJavaScriptテストスクリプトを実行します。

Postmanのテストスクリプトはレスポンスをチェックします：

pm.test("Status code is 200", function () {
    pm.response.to.have.status(200);
});

pm.test("Order total is a positive number", function () {
    const body = pm.response.json();
    pm.expect(body.total).to.be.a("number");
    pm.expect(body.total).to.be.above(0);
});

Postmanはインタラクティブな作業向けに構築されています。新しいエンドポイントをデバッグする開発者は、リクエストを送信し、レスポンスを検査し、ヘッダーを微調整し、数秒で反復作業を行います。QAエンジニアはそれらのリクエストを保存されたリグレッションスイートに変換します。チームはワークスペースを共有し、全員が同じコレクションから作業します。これらすべては視覚的なインターフェースの恩恵を受けています。PostmanでAPIをテストする方法に関するガイドでは、このワークフローを詳しく説明しています。

Postmanが想定していないのは、無人実行です。スイートを実行するには、アプリを開いてコレクションランナーをクリックする必要があります。これはデスクにいる人にとっては問題ありませんが、ビルドサーバーにとっては無用です。

Newmanとは

NewmanはPostmanの公式コマンドラインコレクションランナーです。これはオープンソースのnpmパッケージで、無料で利用でき、Postmanが生成するコレクションファイルを完全に同じように実行します。コレクションをJSONファイルとしてエクスポートし、Newmanに渡すと、Newmanはすべてのリクエストとすべてのテストスクリプトを実行し、結果をターミナルに報告します。

npmでインストールします：

npm install -g newman

コレクションを実行します：

newman run orders-api.postman_collection.json \
  --environment staging.postman_environment.json

Newmanは各リクエストを実行し、Postmanと同じpm.testアサーションを実行し、概要を出力します。重要な点は、NewmanがPostmanと同じ実行エンジンを使用しているため、GUIで合格するコレクションはコマンドラインでも同じように動作するということです。書き換えや別のテスト言語は必要ありません。

Newmanは、いずれかのテストが失敗するとゼロ以外のステータスコードで終了します。この単一の動作が自動化において重要です。ビルドシステムはこの終了コードを読み取り、アサーションの破損によってビルドを失敗させます。成功した実行はゼロで終了し、パイプラインは継続されます。

サイドバイサイド比較

側面	Postman	Newman
インターフェース	グラフィカルデスクトップアプリ	コマンドライン、UIなし
主な用途	作成、デバッグ、探索	自動化された無人実行
実行場所	開発者のマシン	CIサーバー、ターミナル、スケジューラ
コスト	無料ティアと有料プラン	オープンソース、完全に無料
インストール	デスクトップインストーラー	npmパッケージ
テストスクリプト	アプリ内で記述および実行	同じスクリプトをヘッドレスで実行
レポート	アプリ内の結果ペイン	ターミナル出力とレポータープラグイン
最適な用途	インタラクティブな反復	繰り返し可能、スクリプト可能な実行

コレクションJSONファイルは両者をつなぐ架け橋です。Postmanで一度作成すれば、Newmanはそれを自動化で永続的に実行します。

NewmanがCI/CDにどのように組み込まれるか

Newmanは主にAPIテストを継続的インテグレーションに組み込むために存在します。このパターンはプロバイダー間で一貫しています。エクスポートされたコレクションと環境ファイルをリポジトリにコミットし、パイプラインにNewmanをインストールして実行し、終了コードでビルドをゲートします。

番号付きのステップでワークフローを説明します：

Postmanからのエクスポート。 Postmanで、コレクションとその環境をJSONファイルとしてエクスポートします。
リポジトリへのコミット。 APIとともにバージョン管理されるように、コードと一緒に保存します。
パイプラインへのNewmanのインストール。 CIジョブにnpm install -g newmanを追加するか、postman/newman Dockerイメージを使用します。
コレクションの実行。 コレクションと環境ファイルを使用してnewman runを呼び出します。
終了コードでのゲート。 いずれかのテストが失敗した場合、Newmanはゼロ以外のコードで終了し、CIプロバイダーはビルドを失敗とマークします。

GitHub Actionsのステップは次のようになります：

- name: Run API tests
  run: |
    npm install -g newman
    newman run orders-api.postman_collection.json \
      --environment staging.postman_environment.json \
      --reporters cli,junit \
      --reporter-junit-export results.xml

--reportersフラグは知っておく価値があります。NewmanにはCLIおよびJUnit XML用の組み込みレポーターが付属しており、コミュニティレポーターはHTML出力などを追加します。特にJUnit XMLを使用すると、CIダッシュボードでテスト結果をネイティブに表示できます。詳細な手順については、CI/CDでのAPIテストの自動化に関するガイドと、GitHub ActionsによるAPIテスト自動化の具体的な内容を参照してください。

便利なNewmanコマンドラインオプション

Newmanには、自動実行の難点を処理する一連のフラグがあります。いくつかのフラグを知っているかどうかが、不安定なジョブと信頼性の高いジョブとの違いを生みます。

--iteration-dataフラグは、NewmanにCSVまたはJSONファイルを指定し、行の値を変数として置き換えながら、各行ごとにコレクション全体を一度実行します。これは、1つのコレクションに多くの入力を与えてNewmanを実行する方法です。--iteration-countフラグは、単にコレクションを固定回数繰り返します。

--bailフラグは、Newmanにコレクションの残りを実行する代わりに、最初の失敗で停止するように指示します。高速フィードバックパイプラインでは、単一の壊れたリクエストは通常、ビルドがすでに失敗することを意味するため、これが望ましいことが多いです。--timeout-requestフラグは、個々のリクエストにかかる時間の最大値を設定し、応答しないサービスでジョブが停止するのを防ぎます。

--delay-requestフラグはリクエスト間に一時停止を挿入し、APIがレート制限を適用している場合に役立ちます。また、--folderを使用すると、コレクション内の指定されたフォルダのみを実行できるため、スモークテストジョブは小さなサブセットを実行し、完全なリグレッションジョブはすべてを実行できます。これらのオプションは、Postman GUIのコレクションランナーには同じスクリプト可能な形式では存在せず、これらがNewmanが無人実行のための実用的な選択肢である理由です。

PostmanからNewmanへの移行でよくある間違い

チームが最初にGUIからNewmanにコレクションを移行する際に、いくつかの問題が繰り返し発生します。最も一般的なのはハードコードされた値です。アクティブな環境で変数が設定されていたためにPostmanで機能したリクエストは、その環境ファイルが--environmentで渡されない場合、Newmanでは失敗します。常に環境を明示的にエクスポートして提供してください。

2つ目は、Postmanクラウドへの依存です。クラウド同期された変数を参照したり、ログインしたPostmanセッションに紐付けられた機能を使用したりするコレクションは、プレーンなJSONファイルから実行された場合に同じように動作しない可能性があります。CIで信頼する前に、エクスポートされたファイルをローカルでNewmanでテストしてください。

3つ目は、エクスポートされたファイルが古くなることを忘れることです。リポジトリ内のコレクションJSONはスナップショットです。誰かがPostmanでコレクションを編集し、再エクスポートしない場合、パイプラインは古いバージョンを実行し続けます。チームは、エクスポートを意図的なコミットとして扱うことでこの問題を解決するか、テスト定義とランナーが同じものであるツールに移行することで解決します。

それぞれをいつ使用するか

人間が作業を行う場合はPostmanを使用してください。新しいAPIの設計、失敗した呼び出しのデバッグ、サードパーティサービスの探索、テストスイートの構築と洗練：これらはすべてインタラクティブであり、GUIで行うべきです。

人間が立ち会わない場合はNewmanを使用してください。すべてのプルリクエスト時、夜間スケジュール、デプロイ後のスモークテストとしてスイートを実行する場合：これらすべてには、スクリプトから実行され、終了コードを通じて報告するツールが必要です。

実際には、境界は「作成」と「実行」です。どちらか一方を選ぶことはありません。Postmanで作成し、Newmanで自動化を行い、コレクションファイルが両者間で作業を運びます。個別のランナーをまったく維持したくない場合は、NewmanなしでCIでPostmanコレクションを実行する方法に関するガイドで他のオプションを説明しています。

統合された代替案：Apidog

PostmanとNewmanの組み合わせを維持するには、コレクションのエクスポート、JSONファイルの同期維持、および個別のランナーの管理が必要です。Apidogは、これらをすべて1つのプラットフォームに統合します。同じアプリ内でAPIを設計し、リクエストをデバッグし、視覚的なアサーションを含む自動テストシナリオを構築し、その後、組み込みのコマンドラインランナーを使用してCI/CDでこれらのシナリオを実行できます。テスト定義と実行エンジンが共に存在するため、エクスポートと同期のステップは不要です。

Apidogは、同じワークスペースでAPI設計、モックサーバー、パフォーマンステストもカバーしているため、作成する機能テストはパイプラインが実行するテストと同一です。Apidogをダウンロードして、そのテスト機能を無料で利用できます。この分野のツールの比較については、APIテストに最適なPostmanの代替ツールのリストを参照してください。

よくある質問

NewmanはPostmanの代替ですか？

いいえ。Newmanはコレクションを作成したり編集したりすることはできません。実行するだけです。コレクションを作成し、テストスクリプトを記述するには、引き続きPostmanまたは別のツールが必要です。Newmanの役割は、完成した作業をヘッドレスで実行することです。これらは補完的であり、互換性があるわけではありません。

Newmanは有料ですか？

いいえ。Newmanはオープンソースであり、完全に無料です。npmパッケージとして配布されています。Postmanには無料ティアと、大規模チーム向けの有料プランがありますが、Newman自体はどのように使用しても費用はかかりません。

PostmanのテストはNewmanでも同じように動作しますか？

はい。NewmanはPostmanと同じ実行エンジンを使用しているため、pm.testアサーションとリクエストロジックは同一に実行されます。Postmanコレクションランナーで合格するコレクションは、Newmanでも同じ結果を生成するため、CIでの利用も安全です。

Newmanはテストの失敗をどのように報告しますか？

Newmanは、いずれかのテストが失敗すると、ターミナルに概要を出力し、ゼロ以外のステータスコードで終了します。この終了コードによってCIシステムは失敗を検出します。Newmanは、JUnit XMLやHTMLを含むレポーターもサポートしているため、結果をダッシュボードやビルドレポートに提供できます。

Node.jsをインストールせずにNewmanを実行できますか？

Newmanはnpmパッケージであるため、直接インストールするにはNode.jsが必要です。それを避けるには、すべてをバンドルした公式のpostman/newman Dockerイメージを使用してください。Dockerアプローチは、ビルドジョブでNode.jsランタイムを管理したくないCI環境で一般的です。