ApidogでのMock APIデータ

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

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

フロントエンドとバックエンドの並行開発中、API仕様は利用可能だがAPIがまだ開発されていない場合。この場合、フロントエンドはモックデータを使用して開発を支援できます。
APIに本番データが含まれており、直接呼び出すのが不便な場合、フロントエンドはモックデータを使用して開発を支援できます。
テスト中、外部データがテストデータセットを必要とする場合、モックデータをデータソースとして使用できます。

はじめに

APIを指定するか、API仕様をインポートします。このAPIには指定されたレスポンスが必要です。 Mock URLをコピーします。 `設計モード`では、「API」タブにあります。

<p style="text-align: center">
<img src="https://api.apidog.com/api/v1/projects/544525/resources/343578/image-preview" style="width: 640px" />
</p>

`デバッグモード`では、「Mock」タブにあります。

<p style="text-align: center">
<img src="https://api.apidog.com/api/v1/projects/544525/resources/343579/image-preview" style="width: 640px" />
</p>

このURLにアクセスしてモックデータを取得します。更新するとデータが更新されます。

<p style="text-align: center">
<img src="https://api.apidog.com/api/v1/projects/544525/resources/343580/image-preview" style="width: 440px" />
</p>

ApidogのMock機能でできること

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

Mockサーバー

Apidogは、ローカルMock、クラウドMock、およびRunner Mockの3つのMock方法を提供します。

ローカルMock

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

ローカルMockは、ローカルのフロントエンドデバッグシナリオに適しています。
環境管理ポップアップのローカルMock環境で、このローカルMockサーバーのURLを確認できます。
ローカルMockサーバーは環境から閉じたり削除したりすることはできません。
ローカルMockはApidogクライアントでのみ利用可能で、Apidog Webでは利用できません。

クラウドMock

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

クラウドMockは、パブリックAPIのサンドボックス環境として適しています。
クラウドMockは暗号化されたアクセスをサポートします。
デフォルトではオフですが、オンまたはオフに切り替えることができます。

:::highlight purple
クラウドMockについて詳しく学ぶ。
:::

Runner Mock

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

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

:::highlight purple
セルフホストRunner Mockについて詳しく学ぶ。
:::

Mockサーバーへのアクセス

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

URLアクセス

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

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

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

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

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

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

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

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

Last modified: 17 days ago