軽量APIモックCLIツールおすすめ

開発用のダミーAPIが必要なのに、30秒以内に用意しなければならない。ホストされたサービスでも、Docker Composeスタックでも、クリックして操作するGUIでもない。ファイルを読み込み、localhostで応答を開始するだけのコマンドです。

軽量モックサーバーが実現するのはまさにそれです。OpenAPI仕様や小さなデータファイルを指定し、コマンドを1つ実行するだけで、実際のバックエンドがまだ構築中でも、フロントエンドやテストが利用できる現実的なエンドポイントが得られます。最高のものは単一のバイナリまたはnpxで実行可能なパッケージとして提供され、1秒未満で起動し、設定はほとんど不要です。ここにあるより重いオプションの中にはJVM上で動作し、はるかに多くの機能を提供するものもあります。これらは高度なリクエストマッチングやステートフルな動作が必要な場合にその真価を発揮します。

このガイドでは、CLIモッカー6つを、どれだけ手間がかからないかという基準でランク付けします。まず何もインストールせずに実行できるものから紹介し、次にスタンドアロンのJVMサーバー、そしてApidog CLIによる統合ルートで締めくくります。以下のインストールコマンドとモックコマンドはすべて、各ツールの公式ドキュメントと照合して確認済みです。コマンドライン以外のより広範な分野に興味がある場合は、最高のAPIモックツールのまとめでGUIやホスト型オプションも紹介しています。

CLIモックツールを「軽量」にするものとは？

軽量性とは、フットプリントと摩擦のことであり、機能数ではありません。これらのツールを比較する際は、次の4つの点を考慮してください。

• インストールサイズと実行時間。 npxで実行できる純粋なNodeパッケージは数メガバイトです。スタンドアロンのJVMサーバーは、Javaランタイムを必要とする20MB以上のjarファイルです。どちらも有効ですが、このリストの両端に位置します。
• 起動速度。 優れたモックサーバーは、エディターに戻る前に起動しています。Nodeベースのツールは、1秒未満でコールドスタートします。
• 初回応答までの設定。 1つのファイルと1つのコマンドで、ゼロからライブエンドポイントまで到達できますか？最も軽量なツールはイエスと答えます。
• ターミナルファースト。 アカウント、ダッシュボード、GUIのステップは不要です。ツールはファイルを読み取り、それをサービスとして提供し、シェルスクリプトやCIジョブに収まります。

ツールは、最も小さく、最も速いものから順に並べられています。Prism、Mockoon CLI、json-serverは、グローバルインストールなしでnpxで実行できるものです。

Prism (Stoplight)

Prismは、OpenAPIファイルを1つのコマンドでライブモックサーバーに変えます。すでに仕様がある場合、これはリストの中で最も手間のかからないモックです。paths、examples、スキーマを読み取り、それらに一致する応答を提供します。

npx @stoplight/prism-cli mock ./openapi.yaml

これにより、http://127.0.0.1:4010でサーバーが起動し、仕様内のすべての操作が配線されます。Prismは、応答用に定義したexampleを返すか、定義されていない場合はスキーマから有効なランダムな応答を生成します。また、受信リクエストを仕様に対して検証するため、不正な呼び出しはサイレントパスではなく適切な422を返します。グローバルインストールの場合、npm install -g @stoplight/prism-cliを使用し、npxを省略します。

最適な用途： コントラクトに忠実なモックを求める仕様優先のチーム。PrismはApache-2.0ライセンスで、OpenAPI 3.1、3.0、2.0、およびPostmanコレクションをサポートしています。

正直な制限： Prismはステートレスです。POSTは何も永続化しないため、作成-読み取りフローを偽装することはできません。そのモックは仕様の品質に依存します。薄い例は薄い応答を意味します。コントラクトに正確なモッキングのためにはそれがまさにポイントであり、REST APIモッキングツールのワークフローと相性が良いです。

Mockoon CLI

Mockoon CLIは、無料のMockoonデスクトップアプリからエクスポートしたデータファイル、またはプレーンなOpenAPI仕様からモックAPIを実行します。デスクトップアプリではルートを視覚的に構築でき、CLIはCIやサーバー上で同じ環境をヘッドレスで実行します。

npx @mockoon/cli start --data ./mockoon-env.json --port 3000

--dataにMockoon環境ファイルまたはOpenAPI JSON/YAMLファイルを指定すると、すぐにサービスを開始します。データファイルが古いMockoonバージョンからのものである場合、CLIは元のファイルに触れずにメモリ内で移行します。永続的なmockoon-cliコマンドを好む場合は、npm install -g @mockoon/cliでグローバルにインストールしてください。

最適な用途： GUIでモックを設計し、ヘッドレスで実行したいチーム。MITライセンスであり、デプロイメント用の公式Dockerイメージがあります。

正直な制限： 最もリッチなルートはデスクトップアプリで構築されるため、JSON環境ファイルを手動で編集するのは面倒です。コンパニオンアプリをまったく使いたくない場合は、Prismやjson-serverがすべてを手書きの単一ファイルにまとめます。

json-server

json-serverは、まだ仕様がない場合にREST APIを偽装する最速の方法です。データを記述するプレーンなJSONファイルを記述するだけで、GET、POST、PUT、PATCH、DELETEを含む完全なREST APIを生成します。

echo '{ "posts": [{ "id": 1, "title": "hello" }] }' > db.json
npx json-server db.json

これにより、http://localhost:3000/postsで実際のCRUDが提供されます。/postsへのPOSTは実際にレコードを追加し、それをdb.jsonに書き戻すため、ステートフルな動作が無料で得られます。これはPrismやWireMockではすぐに得られないものです。また、クエリパラメータを介したフィルタリング、ソート、ページネーションも利用できます。現在の1.xラインはデフォルトでファイルを監視し、変更時にリロードします。常にPATHに含めたい場合は、npm install -g json-serverでグローバルにインストールしてください。

最適な用途： 実際のAPIが存在する前に、1分で機能するRESTバックエンドが必要なフロントエンド開発者。MITライセンスであり、仕様が一切不要なRESTful API向けの軽量モックサーバーオプションの一つです。

正直な制限： リソーススタイルのREST形式を前提としています。深くカスタムされたルート、非RESTエンドポイント、厳密なヘッダーマッチングは、クリーンに行える範囲を超えています。これはプロトタイピングツールであり、契約バリデーターではありません。

MockServer

MockServerは、正確なリクエストマッチングのための重量級ツールです。上記のツールが仕様やデータファイルを提供するのに対し、MockServerでは期待値を定義できます。メソッド、パス、ヘッダー、クエリ、またはボディによってリクエストをマッチングさせ、その後、遅延やタイムアウト、エラー処理のテストのための失敗を含め、正確に希望する応答を返します。

java -jar mockserver-netty-5.15.0-no-dependencies.jar -p 1080

これにより、MockServerがポート1080で起動します。その後、そのREST APIに期待値を送信して動作を設定したり、プログラムで制御したりできます。Nodeユーザーは、生のjarをスキップして公式ラッパーを使用できます。

npm install mockserver-node

const mockserver = require('mockserver-node');
mockserver.start_mockserver({ serverPort: 1080 });

最適な用途： リクエストがどのようなものであるべきか、モックがどのように応答するかについてきめ細かい制御が必要な統合テスト。Apache-2.0ライセンスで、単一ポートでHTTP、HTTPSなどをサポートしています。

正直な制限： JVMサーバーであるため、Nodeツールよりも重く起動が遅く、期待値の設定は仕様を指定するよりも冗長です。仕様を提供するだけであればこれは過剰ですが、もしこれを使い切ってしまった場合、MockServerの代替品の比較はトレードオフを説明しています。

WireMock (スタンドアロン)

WireMockは、JavaおよびJVMテストの世界で人気のある、もう1つの確立されたJVMモックサーバーです。そのスタンドアロンjarは、JUnitテストに組み込むのと同じエンジンを実行するため、ローカル開発で構築したモックはテストスイートに直接持ち込めます。

java -jar wiremock-standalone.jar --port 8080

これにより、ポート8080でサービスが提供されます。WireMockはmappings/ディレクトリまたはそのJSON APIからスタブマッピングを読み取り、また実際のトラフィックを記録してスタブとして再生することもできます。これは、制御できないサードパーティAPIをモックする際に便利です。CI用には公式のwiremock/wiremock Dockerイメージがあります。

最適な用途： ローカル開発とテストスイートで共有する単一のモッキングエンジン、さらに記録および再生機能を求めるJVMチーム。Apache-2.0ライセンスです。

正直な制限： MockServerと同様に、Javaランタイムが必要で、Nodeオプションよりも起動が遅いです。そのスタブマッピングJSONは強力ですが、単一ファイルのデータモックよりも学習することが多くなります。JavaScript側から来た場合、Mock Service Worker (MSW)の代替品の比較は、ブラウザファーストのモッキングに対してWireMockがどのように位置づけられるかをカバーしています。

Apidog CLI

上記のツールはそれぞれモッキングの一部分を解決します。Apidogは統合されたアプローチを採用しています。API設計、モック、テスト、ドキュメントがすべて1つのプロジェクトに存在し、Apidog CLIがそのプロジェクトをターミナルから駆動します。Apidogはオープンソースではありません。無料プランのある商用製品です。しかし、その無料プランとCLIがあれば、個別のモックサーバー、テストランナー、仕様ツールを組み合わせる代わりに利用できる選択肢となります。

Apidogは、定義するすべてのエンドポイントからスマートモックを自動生成し、スキーマのフィールドタイプと命名規則に従った応答を返します。そのため、phoneフィールドはランダムな文字列ではなく、もっともらしい電話番号を返します。特定のリクエストに対して特定の応答が必要な場合は、モックの期待値を追加します。CLIは、これらのモックリソースをプロジェクトの一部として管理します。

npm install -g apidog-cli
apidog login --with-token <YOUR_TOKEN>
apidog mock --help

mockコマンドグループは、エンドポイント、スキーマ、環境、テスト実行のためのコマンドグループと同様に、スクリプトやCIからプロジェクトのモック期待値と連携します。出力は構造化されたJSONで、agentHints.nextStepsフィールドがあり、AIエージェントだけでなく人間も利用できます。完全なコマンド表面については、Apidog CLI完全ガイドでカバーされています。

最適な用途： 3つの異なるツールを実行するよりも、モック、仕様、テストを1か所にまとめておきたいチーム。Apidogをダウンロードして、組み込みのモックサーバーとCLIを自分のプロジェクトでお試しください。

正直な制限： 単一目的のバイナリではなくプラットフォームであるため、json-serverが何も要求しないのに対し、プロジェクトとログインを要求します。1つのファイルからの一時的なモックだけが必要な場合は、より軽量なツールが優位です。すでにApidogでAPIを設計している場合は、モックはすでにそこにあります。

選び方

すでにあるものに合わせてツールを選びましょう。OpenAPI仕様がある場合は、PrismまたはMockoon CLIが直接それを提供します。まだ何もなければ、json-serverがJSONファイルからAPIを生成します。正確なリクエストマッチングが必要な場合は、MockServerまたはWireMockを選びましょう。モックを設計やテストと並行して使いたい場合は、Apidogを使用します。

大まかなルールは次のとおりです。スピードを求めるならnpxツール、マッチングの深さを求めるならJVMサーバー、複数のワークフローではなく1つのワークフローを求めるならApidog。そもそもモックを使用すべきかどうかまだ迷っている場合は、APIモッキングのユースケースの解説で、いつそれが報われるかをカバーしています。

まとめ

軽量モッキングは、1つの質問に集約されます。ツールに何を投入する準備ができていますか？仕様があればPrismまたはMockoon CLIへ。白紙の状態であればjson-serverへ。厳密なマッチングが必要ならMockServerまたはWireMockへ。そして、複数のツールを起動して接続したくないのであれば、Apidogがモックを設計とテストの隣に置き、どうせスクリプト化するであろう同じCLIから駆動します。

これら6つのツールはすべてターミナルから実行でき、CIジョブに組み込むことができ、数時間ではなく数秒でダミーAPIを提供します。自分のケースをカバーできる最小限のツールを選び、本当に必要になったときにだけ重い機能を追加しましょう。統合されたバージョンをご覧になりたい場合は、Apidogをダウンロードして、API設計からワンステップでモックサーバーを生成してください。