ApidogにおけるモックAPIデータ

Apidogは、API仕様に基づいて合理的なレスポンスを生成する効率的なモックエンジンを提供しており、特定の設定を必要とせずに高い効率を実現します。

APIモッキングは以下のシナリオで使用できます：

フロントエンドとバックエンドの並行開発中、API仕様は利用可能だがAPIがまだ開発されていない場合。この場合、フロントエンドはモックデータを使用して開発を支援できます。

APIに本番データが含まれており、直接呼び出すのが不便な場合、フロントエンドはモックデータを使用して開発を支援できます。

テスト中、外部データがテストデータセットを必要とする場合、モックデータをデータソースとして使用できます。

はじめに

APIを指定するか、API仕様をインポートします。このAPIには指定されたレスポンスが必要です。

「モック」タブに移動し、モックURLをクリックしてコピーします。

このURLをブラウザに貼り付けてモックデータを取得します。リフレッシュするとデータが更新されます。

Apidogのモック機能でできること

Apidogのモック機能は以下の要件を満たすことができます：

API仕様に基づいて自動生成されたデータを返す。

API仕様で指定されたレスポンス例を返す。

指定されたレスポンスを返す。

異なるリクエストパラメータに基づいて異なるカスタムレスポンスを返す。

リクエストパラメータに関連するパラメータを持つレスポンスを返す。

モックサーバー

Apidogは、ローカルモック、クラウドモック、およびセルフホスト型モックの3つのモック方法を提供します。

ローカルモック

ローカルモックは、Apidogクライアントと一緒にコンピュータにインストールされるサーバーです。Apidogクライアントが開いているときに動作し、Apidogクライアントが開いている間のみ機能します。

ローカルモックは、ローカルのフロントエンドデバッグシナリオに適しています。

環境管理ポップアップのローカルモック環境で、このローカルモックサーバーのURLを確認できます。

ローカルモックサーバーは環境から閉じたり削除したりすることはできません。

ローカルモックはApidogクライアントでのみ利用可能で、Apidog Webでは利用できません。

クラウドモック

クラウドモックはローカルモックと同じ機能を持ちますが、Apidogサーバー上にデプロイされます。ローカルモックとは異なり、ローカルマシンが開いているかどうかに依存せず、いつでもどのマシンからでもクラウドモックデータにアクセスできます。

クラウドモックは、パブリックAPIのサンドボックス環境として適しています。

クラウドモックは暗号化されたアクセスをサポートします。

デフォルトではオフですが、オンまたはオフに切り替えることができます。

クラウドモックについて詳しく学ぶ。

セルフホスト型モック

セルフホスト型モックサーバーは、チームが自己デプロイしたRunner上にあります。チームはまずサーバー上にRunnerをデプロイする必要があり、その後、すべてのチームメンバーがこのRunnerを使用してモックデータを生成できます。これもローカルマシンが開いているかどうかに依存しません。

セルフホスト型モックは、大規模な自動テストのデータソースとして、または非公開APIのサンドボックス環境として使用するのに適しています。

セルフホスト型モックについて詳しく学ぶ。

モックサーバーへのアクセス

モックサーバーにアクセスする主な方法は2つあります：URLアクセスとApidog送信です。

URLアクセス

ApidogのすべてのHTTP APIには「モック」モジュールがあります。設計モードでは「API」タブに、デバッグモードでは「モック」タブにあります。

ここでモックURLをコピーし、どこでも使用してモックデータをリクエストできます。
APIが複数のレスポンスまたは複数のモック期待値を指定している場合、各レスポンス/期待値には独自のモックURLがあります。

「リクエスト」をクリックして、Apidog内で直接これらのリクエストを行うことができます。

注意：「クリックしてコピー」を使用すると、ここではURLのみがコピーされ、メソッドとボディは含まれません。リクエストを行う際にこれらの必要な部分を追加する必要があります。

Apidog内でのモックデータへのアクセス

各Apidogプロジェクトでは、右上の環境スイッチャーでローカルモックとクラウドモックを見つけることができます。

環境をローカルモック/クラウドモックに切り替えると、Apidog内のリクエストは対応するモック環境に送信されます。

注意：Apidog内のAPIで、パスが「/」で始まるもののみがモック環境に送信されます。独自のプレフィックスURLを持ち、「/」で始まらない APIはモック環境に送信されません。

ApidogにおけるモックAPIデータ

はじめに#

Apidogのモック機能でできること#

モックサーバー#

ローカルモック#

クラウドモック#

セルフホスト型モック#

モックサーバーへのアクセス#

URLアクセス#

Apidog内でのモックデータへのアクセス#