カスタムモック

Apidog は、API レスポンスを細かく制御できる強力なモックカスタマイズ機能を提供します。本ドキュメントでは、モックデータをカスタマイズする 2 つの方法を紹介します。

フィールドレベルのカスタマイズ: 一部のフィールドを制御し、その他にはスマートモックを使用します

レスポンス全体のカスタマイズ: 期待値を使用して、完全なモックレスポンス（固定、条件付き、または動的）を定義します

フィールドレベルのカスタマイズ

特定のフィールドに具体的な値を定義しつつ、残りは Apidog に自動生成させたい場合があります。Apidog は、フィールドレベルで制御するための柔軟な方法を提供します。

カスタムフィールド値の設定

1. 固定値

エンドポイント仕様のモックフィールドに静的な値を指定します。Apidog は、そのフィールドに対して常にこの正確な値を返し、未指定のフィールドにはスマートモックを使用します。

例:

2. Faker.js による動的値

Apidog の動的値（Faker.js ベース）を使用して、現実的なランダムデータを生成します。次の構文を使用します。

{{$category.method}}

一般的な例:

式	結果の例
`{{$person.fullName}}`	Rachel Wheeler
`{{$internet.email}}`	Arno.Huels33@yahoo.com
`{{$commerce.productName}}`	Elegant Plastic Bike

ドロップダウンメニューから動的値を直接選択できます。

3. パラメータ化された Faker メソッド

Apidog の拡張 Faker.js 構文を使用して、動的値メソッドにパラメータを渡し、特殊なデータ生成を行います。

例:

ユースケース	式	説明
整数範囲	`{{$number.int(min=0,max=10000)}}`	0 から 10,000 までのランダムな整数
読みやすい電話番号	`{{$phone.number(style='human')}}`	人間が読みやすい電話番号形式
N の倍数	`{{$number.int(multipleOf=3)}}`	3 で割り切れる整数
配列要素	`{{$helpers.arrayElement(['red','blue','green'])}}`	配列からランダムな色を選択
日付範囲	`{{$date.between(from='2024-01-01',to='2024-12-31',format='yyyy-MM-dd')}}`	指定範囲内の日付

モジュール、メソッド、パラメータの完全な一覧については、動的値モジュールのドキュメントをご確認ください。

4. 複数の式の連結

静的テキストと複数の動的式を組み合わせて、複雑なフィールド値を生成します。

例: 住所全体の生成

{{$location.streetAddress}}, {{$location.city}}, {{$location.state}}, {{$location.zipCode}}, {{$location.country}}

サンプル出力:

8507 Hudson Alley, Rochester, Wisconsin, 96512, United States

各コンポーネントは動的に生成されるため、モック API 呼び出しごとに一意で現実的な住所が作成されます。

モックロケール

Apidog はカスタマイズ可能なモックロケールをサポートしており、対象地域や対象ユーザーに合わせた異なる言語や形式で動的テストデータを生成できます。モックロケールの設定方法について詳しくは、モック言語（ロケール）をご覧ください。

レスポンス全体のカスタマイズ（モック期待値）

モックレスポンスを完全に制御するには、モック期待値を使用します。この機能により、固定、条件付き、または動的なレスポンスを定義できます。

モック期待値の作成

固定レスポンス

無条件の期待値を作成することで、すべてのリクエストに対して同じデータを返します。

手順:

New expectation をクリックします

期待値名を追加し、条件は空白のままにします

返したいレスポンスデータを入力し、保存します

提供されたモック URL をコピーして使用し、このエンドポイントにアクセスします

条件付きレスポンス

リクエストパラメータに基づいて、異なるモックデータを返します。モックエンジンは条件を上から下へ評価し、最初に一致した期待値を返します。

サポートされている条件タイプ:

パラメータタイプ	説明
クエリパラメータ	URL クエリ文字列
パスパラメータ	動的 URL セグメント
ヘッダーパラメータ	HTTP ヘッダー
Cookie パラメータ	Cookie 値
ボディパラメータ	JSON パス経由の JSON ボディフィールド

条件の動作

複数の条件は AND ロジックで結合されます（すべて一致する必要があります）

どの条件にも一致しない場合、Apidog は Project Settings → Feature Settings → Mock Settings のモックメソッド優先度にフォールバックします

制限事項

ボディパラメータは JSON のみをサポートし、XML はサポートしません

パラメータ条件では {{variables}} を使用できません

リクエストボディ形式は API 仕様（例: form-data、JSON）と一致している必要があります

IP アドレス条件を使用すると、特定の IP へのレスポンスに制限できます

動的モックデータ

モック期待値では、Faker.js と Nunjucks のテンプレート構文を使用して、動的なランダムデータをサポートします。

例:

{
    "data": [
        {% for i in range(0, 20) %}
        {% if i>1 %},{% endif %}
        {
            "id": {{i}},
            "firstname": "{{$person.firstName}}",
            "lastname": "{{$person.lastName}}"
        }
        {% endfor %}
    ],
    "success": true
}

これにより、次が生成されます:

20 個のユーザーオブジェクトの配列（id は 0 から 19）

それぞれにランダムに生成された名と姓が含まれます

定数の "success": true フィールド

構文メモ:

構文	目的
`{{$...}}`	Faker.js を呼び出してランダム値を生成します
`{% for ... %}`	Nunjucks のループ構造
`{{i}}`	Nunjucks のループ変数（Apidog 変数ではありません）

重要な違い

Apidog では ネイティブ Faker.js の faker.person.firstName() ではなく、{{$person.firstName}} を使用します

Apidog のプロジェクト/環境変数（{{variable}}）は、モック期待値では使用できません

完全な構文については、Faker.js と Nunjucks のドキュメントを参照してください

高度な機能

カスタムレスポンスヘッダー

モック期待値にカスタムヘッダーを追加して、認証、ページネーション、その他の API 動作をシミュレートします。

高度なレスポンスプロパティ

More タブで追加のレスポンスプロパティを設定します。

プロパティ	目的	デフォルト
HTTP ステータスコード	エラーまたは特殊なケースをシミュレートします	200
レスポンス遅延	ネットワーク遅延（ミリ秒）をシミュレートします	0

期待値の有効化/無効化

期待値リストから、ローカルおよびクラウドのモック環境ごとに、期待値のオン/オフを個別に切り替えます。

まとめ

Apidog のカスタムモック機能は、次を提供します。

固定値または動的値による柔軟なフィールドカスタマイズ

モック期待値によるレスポンス全体の制御

パラメータベースのレスポンスのための条件ロジック

Faker.js と Nunjucks を使用した動的データ生成

カスタムヘッダー、遅延、ステータスコードによる高度なシミュレーション

これらの機能により、本番環境の動作を正確に反映した、堅牢で高忠実度の API シミュレーションを作成できます！

カスタムモック

フィールドレベルのカスタマイズ#

カスタムフィールド値の設定#

1. 固定値#

2. Faker.js による動的値#

3. パラメータ化された Faker メソッド#

4. 複数の式の連結#

レスポンス全体のカスタマイズ（モック期待値）#

モック期待値の作成#

固定レスポンス#

条件付きレスポンス#

動的モックデータ#

高度な機能#

カスタムレスポンスヘッダー#

高度なレスポンスプロパティ#

期待値の有効化/無効化#

まとめ#

フィールドレベルのカスタマイズ

カスタムフィールド値の設定

1. 固定値

2. Faker.js による動的値

3. パラメータ化された Faker メソッド

4. 複数の式の連結

レスポンス全体のカスタマイズ（モック期待値）

モック期待値の作成

固定レスポンス

条件付きレスポンス

動的モックデータ

高度な機能

カスタムレスポンスヘッダー

高度なレスポンスプロパティ

期待値の有効化/無効化

まとめ