DEV Community

Cover image for CI/CDでのAPIテストに最適なPostman CLI代替ツール
Akira
Akira

Posted on • Originally published at apidog.com

CI/CDでのAPIテストに最適なPostman CLI代替ツール

Postman CLIはPostmanコレクションをCI/CDパイプラインで実行する便利な方法ですが、実行結果がPostmanアカウントとPostmanクラウドに紐づくため、すべてのチームに適しているわけではありません。この記事では、CIでAPIテストを実行するための5つの代替案と、それぞれをどう選び、どう組み込むかを整理します。推奨候補としてのApidog CLIの位置づけも解説します。Postman CLIとNewmanの関係については、Postman自身のPostman CLIとNewmanの比較も参考になります。

今すぐApidogを試す

チームがPostman CLIを見送る理由

Postman CLIは、PostmanがCI/CD向けに推奨しているコマンドラインツールです。Postmanコレクションを実行し、結果をPostmanアプリ側に報告できます。

ただし、この「Postmanクラウドに結果を送る」設計が、チームによっては制約になります。

主な判断ポイントは次の3つです。

  • クラウド連携

    Postman APIキーで認証し、実行結果をPostmanクラウドに送信します。エアギャップ環境やコンプライアンス要件が厳しい環境では採用しづらい場合があります。

  • ライセンス

    コレクション、環境、チーム機能はPostmanのプランに依存します。チーム規模が大きくなるほど、シート単位のコストが判断材料になります。

  • ロックイン

    テスト資産の中心がPostmanコレクションになります。将来的に別ツールへ移行する場合、エクスポートや再構成が必要になります。

つまり、Postman CLIが悪いツールというわけではありません。

ただし、次のような要件がある場合は代替ツールを検討する価値があります。

  • テストをGitリポジトリで管理したい
  • オフラインまたは閉域環境で実行したい
  • CI実行をクラウドアカウントに紐づけたくない
  • パイプライン実行にシート課金を持ち込みたくない
  • API設計、モック、テスト、ドキュメントを同じソースで管理したい

クイック比較

ツール テスト形式 実行に必要なアカウント ライセンス 最適な用途
Apidog CLI Apidogのテストシナリオ/スイート、またはエクスポートされたファイル 不要。プロジェクト同期にはトークンベース 商用、無料ティアあり 設計、モック、テスト、ドキュメントを一箇所で管理するチーム
Newman PostmanコレクションJSON 不要 オープンソース、Apache-2.0 既存のPostmanコレクションをオフライン実行したいチーム
Hoppscotch CLI HoppscotchコレクションJSON 不要。JSONエクスポートパスあり オープンソース Hoppscotchユーザー、セルフホスト環境
inso / Insomnia CLI Git同期経由のInsomniaテストスイート 不要 オープンソース InsomniaとGit中心のチーム
Hurl プレーンテキストの.hurlファイル 不要 オープンソース curlに近い形式でAPIテストを管理したいエンジニア

1. Apidog CLI

Apidog CLIは、API設計、デバッグ、テスト、モック、ドキュメントを扱うApidogのヘッドレスランナーです。ターミナルやCI/CDからapidog runを実行し、テストシナリオやテストスイートを自動実行できます。

Apidog CLI

Apidog CLIの強みは、単なるランナーではなく、API仕様、テスト、モック、ドキュメントと同じプロジェクトを参照して実行できる点です。CIで実行するテストが、設計・ドキュメント化されたAPIと同じ情報源に基づきます。

CIに組み込む基本イメージ

ApidogのCI/CD設定画面で生成されたコマンドを、GitHub Actions、GitLab CI、Jenkinsなどに貼り付けます。

例：

apidog run
Enter fullscreen mode Exit fullscreen mode

レポート形式を指定する場合：

apidog run -r cli,html,json,junit
Enter fullscreen mode Exit fullscreen mode

データ駆動テストを行う場合：

apidog run -d ./test-data.csv
Enter fullscreen mode Exit fullscreen mode

またはJSONを使います。

apidog run -d ./test-data.json
Enter fullscreen mode Exit fullscreen mode

Apidog CLIが向いているケース

  • OpenAPI仕様、テスト、モック、ドキュメントを同じ場所で管理したい
  • CI/CDでAPI回帰テストを自動化したい
  • HTML、JSON、JUnitなど複数形式でレポートを出したい
  • モックサーバーも含めてAPI開発フローを整えたい
  • API仕様をAIエージェントやIDEから参照できる形にしたい

実装時に使う主な機能

  • apidog runによるCI実行

    CI/CD向けに生成されたコマンドをそのまま使えます。詳しい手順はステップバイステップのCLIチュートリアルで確認できます。

  • データ駆動型テスト

    -dフラグでCSVまたはJSONを指定し、同じテストを複数データで繰り返せます。

  • CI向けレポート出力

    -rフラグでcli、html、json、junitを指定できます。JUnit形式はCIのテストレポート機能と相性が良いです。

  • モックサーバー連携

    Apidogのモックサーバーはスキーマからレスポンスを生成できます。フロントエンドや統合テストがライブバックエンドを待たずに進められます。詳しくはAPIモックのガイドを参照してください。

  • AIエージェント対応

    Apidog MCPサーバーにより、Cursor、Claude、VS CodeなどのAIエージェントやIDEがAPI仕様を参照できます。詳細はApidog MCPサーバーで解説されています。

Apidogには無料ティアと、Apidogから入手できるデスクトップアプリがあります。Postman CLIとの直接比較を見たい場合は、Apidog CLI vs Postman CLIを参照してください。

2. Newman

Newmanは、Postmanのオリジナルのオープンソースコレクションランナーです。PostmanコレクションJSONをコマンドラインから実行でき、PostmanアプリやPostmanクラウドへの結果送信は必須ではありません。

Newman

基本的な実行例

PostmanからコレクションをJSONとしてエクスポートし、Newmanで実行します。

newman run collection.json
Enter fullscreen mode Exit fullscreen mode

環境ファイルを指定する場合：

newman run collection.json -e environment.json
Enter fullscreen mode Exit fullscreen mode

JUnitレポートを出力する場合：

newman run collection.json \
  -e environment.json \
  --reporters cli,junit \
  --reporter-junit-export results.xml
Enter fullscreen mode Exit fullscreen mode

Newmanの強み

  • Apache-2.0ライセンスのオープンソース
  • PostmanコレクションJSONをそのまま実行できる
  • CI/CD向けの利用例が多い
  • レポーターのエコシステムが豊富
  • 既存のPostman資産を活かしやすい

トレードオフ

Newmanでも、テスト資産の中心はPostmanコレクションです。

「Postmanコレクションを使い続けたいが、Postman CLIのクラウド連携は避けたい」というケースには適しています。

一方で、API仕様、モック、ドキュメント、テストを統合的に管理したい場合は、別のツールの方が合うことがあります。

PostmanはNewmanを非推奨にする計画はないと述べており、安定した選択肢です。Apidog CLIとの違いはApidog CLI vs Newmanで確認できます。

3. Hoppscotch CLI

Hoppscotchは、オープンソースでセルフホスト可能なAPIクライアントです。Hoppscotch CLI、つまり@hoppscotch/cliを使うと、HoppscotchのコレクションをCIで実行できます。

hopp testコマンドはコレクション内のリクエストを実行し、各リクエストに紐づくテストスクリプトでレスポンスを検証します。

基本的な実行イメージ 

hopp test collection.json
Enter fullscreen mode Exit fullscreen mode

環境ファイルを指定する場合：

hopp test collection.json --env environment.json
Enter fullscreen mode Exit fullscreen mode

JUnitレポートを出力する場合：

hopp test collection.json --reporter-junit results.xml
Enter fullscreen mode Exit fullscreen mode

Hoppscotch CLIの強み

  • オープンソース
  • セルフホスト可能
  • JSONエクスポートからテストを実行できる
  • コレクションIDを使った実行にも対応
  • --reporter-junitでCIに取り込みやすいレポートを出せる

向いているケース

Hoppscotch CLIは、すでにHoppscotchを使っていて、軽量なブラウザファーストのAPI開発体験をCIにも持ち込みたい場合に適しています。

GUIを含めた選択肢を比較したい場合は、Hoppscotchの代替案のまとめも参考になります。

4. inso / Insomnia CLI

insoはKong Insomniaのコマンドラインツールです。Insomniaで作成したテストスイートをCLIから実行できます。

特に重要なのは、InsomniaのGit同期との相性です。Git同期を使うと、Insomniaの仕様、コレクション、テストスイートをリポジトリ内の.insomniaディレクトリで管理できます。

基本的な実行例

名前付きテストスイートを実行します。

inso run test "My API Test Suite"
Enter fullscreen mode Exit fullscreen mode

CIで使う場合は、リポジトリに含まれる.insomniaディレクトリをチェックアウトした上で実行します。

git checkout main
inso run test "My API Test Suite"
Enter fullscreen mode Exit fullscreen mode

insoの強み

  • Gitネイティブ

    テスト資産をリポジトリ内のファイルとして管理できます。

  • 名前付きテストスイートの実行

    inso run test "My API Test Suite"のように、Insomnia上のテストスイートを直接指定できます。

  • CI/CDに組み込みやすい

    GitHub Actions、GitLab CI、Jenkinsなどのパイプラインで実行できます。

向いているケース

すでにInsomniaでAPIを設計・検証しており、ベンダークラウドを経由せずにGit管理されたテストをCIで実行したい場合、insoは自然な選択肢です。

Apidog CLIとの違いはApidog CLI vs insoで確認できます。

5. Hurl

Hurlは、プレーンテキストの.hurlファイルでHTTPリクエストとアサーションを書くCLIツールです。Rust製のバイナリで、libcurlを利用します。起動が速く、Node.jsやGUI、アカウントを必要としません。

Hurl

.hurlファイルの例 

GET https://api.example.com/users/1

HTTP 200
[Asserts]
jsonpath "$.id" == 1
jsonpath "$.email" exists
header "Content-Type" contains "application/json"
Enter fullscreen mode Exit fullscreen mode

複数リクエストを同じファイルに書くこともできます。

POST https://api.example.com/login
Content-Type: application/json

{
  "email": "user@example.com",
  "password": "password"
}

HTTP 200
[Captures]
token: jsonpath "$.token"

GET https://api.example.com/me
Authorization: Bearer {{token}}

HTTP 200
[Asserts]
jsonpath "$.email" == "user@example.com"
Enter fullscreen mode Exit fullscreen mode

CIでの実行例 

hurl --test tests/*.hurl
Enter fullscreen mode Exit fullscreen mode

JUnitレポートが必要な場合：

hurl --test --report-junit results.xml tests/*.hurl
Enter fullscreen mode Exit fullscreen mode

Hurlの強み

  • プレーンテキストで管理できる

    .hurlファイルはGit差分が読みやすく、レビューしやすいです。

  • 依存関係が少ない

    Node.js、GUI、アカウントが不要です。

  • CIに組み込みやすい

    標準的な終了コードを返すため、パイプラインで扱いやすいです。

  • curlに近い感覚で書ける

    HTTPリクエスト、値のキャプチャ、ヘッダーやJSONボディのアサーションを素直に記述できます。

トレードオフ

HurlはAPIプラットフォームではありません。API設計画面、モックサーバー、ドキュメント生成は提供しません。

その代わり、HTTPエンドポイントの動作を最小構成で検証したい場合には非常に強力です。形式の詳細は公式Hurlドキュメントを参照してください。

選び方

ツール選定では、現在のAPIワークフローに合わせるのが最も実装しやすいです。

  • すでにPostmanを深く使っていて、オフライン実行したい

    Newmanを選びます。

  • Hoppscotchを使っている、またはセルフホストしている

    Hoppscotch CLIを選びます。

  • Insomniaを使っており、Git管理を重視している

    insoを選びます。

  • 最小限のテキストベースでAPIテストを管理したい

    Hurlを選びます。

  • 設計、モック、テスト、ドキュメントを一箇所で管理したい

    Apidog CLIを選びます。

APIを単なるコレクションの集まりではなく、プロダクトとして扱う場合は、仕様、テスト、モック、ドキュメントを同じソースで管理できる構成が拡張しやすくなります。この考え方はAPI as a productで詳しく解説されています。

また、CI/CDへの組み込み方はAPIテストのCI/CDベストプラクティスも参考になります。

よくある質問

無料のPostman CLI代替案はありますか？

はい。Newman、Hoppscotch CLI、inso、Hurlはオープンソースで無料で実行できます。

Apidog CLIには無料ティアがあり、有料プランと同じapidog runコマンドを実行できます。いずれも、パイプライン実行ごとに課金されるタイプのランナーではありません。

既存のPostmanコレクションをPostman CLIなしで実行できますか？

はい。NewmanはPostmanコレクションJSONを直接実行できます。

また、ApidogはPostmanコレクションをインポートした上で、ヘッドレス実行できます。移行手順はNewmanなしでCIでPostmanコレクションを実行する方法で解説されています。

Postman CLIとNewmanの違いは何ですか？

どちらもPostmanコレクションをコマンドラインから実行できます。

主な違いは実行結果の扱いです。

  • Postman CLIはPostman APIキーでログインし、実行結果をPostmanアプリケーションに報告します。
  • Newmanはスタンドアロンのオープンソースランナーで、クラウドへの結果送信を前提にしません。

PostmanはNewmanを非推奨にする計画はないと述べています。

CI/CDに最適な代替案はどれですか？

スタックによります。

  • Postman資産を活かすならNewman
  • Hoppscotch中心ならHoppscotch CLI
  • InsomniaとGit同期中心ならinso
  • テキストベースで最小構成にしたいならHurl
  • API設計、モック、テスト、ドキュメントまで一体で扱いたいならApidog CLI

単一プラットフォームでAPIライフサイクル全体を扱いたい場合は、Apidog CLIが有力です。

まとめ

Postman CLIは便利ですが、クラウド連携、ライセンス、ロックインが課題になるチームもあります。

その場合は、次のように選ぶと実装しやすくなります。

  • Postmanコレクションをそのまま使うならNewman
  • HoppscotchのワークフローをCIに持ち込むならHoppscotch CLI
  • InsomniaのテストをGit管理するならinso
  • プレーンテキストで軽量にテストするならHurl
  • API仕様、モック、テスト、ドキュメントを同じ情報源で管理するならApidog CLI

APIライフサイクル全体に紐づくランナーが必要な場合は、Apidog CLIを試す価値があります。Apidogをダウンロードして最初のAPIテストをコマンドラインから実行するか、Apidogでプラットフォームの詳細を確認してください。

Top comments (0)