Apidog は、API 仕様に基づいて現実的な API レスポンスを自動生成する効率的なモックエンジンを提供します。この強力な機能により、手動設定の必要がなくなり、開発およびテストのワークフローを高速化できます。ユースケース#
モック API は、さまざまな開発およびテストのシナリオで有用です。| シナリオ | 説明 | メリット |
|---|
| 並行開発 | API が設計済みであ るものの、まだ実装されていない場合のフロントエンド開発 | フロントエンドチームはバックエンドの完了を待たずに作業を進められます |
| データセキュリティ | 開発中に本番データが露出することを回避します | データプライバシーとセキュリティコンプライアンスを維持します |
| テスト | 外部依存関係のためのテストデータセットを作成します | 一貫性があり制御されたテストデータを確保します |
はじめに#
1
エンドポイントを作成するか、API 仕様をインポートします。エンドポイントには指定されたレスポンスが必要です。
2
Mock タブに移動し、モック URL をクリックしてコピーします。
3
URL をブラウザに貼り付けて、モックデータを取得します。ページを更新すると新しいデータが生成されます。
モック機能#
Apidog のモック機能は、さまざまなレスポンスタイプをサポートしています。モックサーバーの種類#
Apidog は、さまざまな開発ニーズに合わせて 3 つのモックサーバーオプションを提供します。ローカルモック#
ローカルモックは、Apidog クライアントと並行してお使いのコンピューター上で実行されます。クライアントが開いている場合にのみ動作します。Apidog クライアントとともに自動的にインストールされます
Apidog クライアントの起動時 に開始されます
環境管理ポップアップの「Local mock environment」でローカルモックサーバーの URL を確認できます。
クラウドモック#
クラウドモックは、ローカルモックと同じ機能を提供しますが、Apidog のサーバー上で実行されます。ローカルマシンが稼働しているかどうかに関係なくアクセスできます。どの場所からでも 24 時間 365 日利用できます
Runner モック#
Runner モックは、チームのセルフホスト Runner インフラストラクチャ上で動作します。サーバーに Runner をデプロイした後、すべてのチームメンバーがそれを通じてモックデータにアクセスできます。お客様のインフラストラクチャ上でセルフホストされます
モックサーバーへのアクセス#
モックデータには、主に 2 つの方法でアクセスできます。URL アクセス#
Apidog のすべての HTTP エンドポイントには Mock モジュールが含まれています。このモジュールからモック URL をコピーし、任意のアプリケーションまたはツールで使用してモックデータをリクエストできます。エンドポイントが複数のレスポンスまたはモック期待値を定義している場合、それぞれに固有のモック URL があります。
Click to copy ボタンでコピーされるのは URL のみです。その URL を別の場所で使用する場合は、HTTP メソッドとリクエストボディを手動で追加する必要があります。
Apidog 内でのモックへのアクセス#
各 Apidog プロジェクトには、環境切り替え（右上隅）にローカルモック環境とクラウドモック環境が含まれています。モック環境を選択すると、Apidog 内のすべてのリクエストが自動的にそのモックサーバーへルーティングされます。/ で始まるパスを持つエンドポイントのみがモック環境に送信されます。完全な URL を持つエンドポイント（/ で始まらないもの）は、モック環境を使用しません。
