カスタムMock

特定フィールドのカスタマイズ#

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

1. 値を直接入力#

2. Faker.jsの動的値を使用#

{{$category.method}}

3. パラメータ付きFakerメソッドを使用#

{{$number.int(min=0,max=10000)}}

{{$phone.number(style='human')}}

{{$number.int(multipleOf=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"

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

Mock期待値の設定#

背景#

固定データの返却#

条件付きデータの返却#

注意

BodyパラメータはJSONのみをサポートし、XMLはサポートしていません。

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

期待値マッチングにBodyパラメータを使用する場合、リクエストBodyの形式はAPI仕様に一致している必要があります（例: form-data、JSONなど）。

特定のIPに対してレスポンスを制限するために、IPアドレス条件を追加することもできます。

動的Mockデータの返却#

例#

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

注意

ApidogはFaker.jsの表現に{{$...}}を使用します（ネイティブJS呼び出し構文ではありません）。

Faker.js（ネイティブ）: faker.person.firstName()

Apidog: {{$person.firstName}}

Apidogのプロジェクト/環境変数（{{variable}}のような）はMock期待値では利用できません。

Faker.jsとNunjucksの完全なドキュメント: Faker.js, Nunjucks

その他の機能#

カスタムレスポンスヘッダー
認証、ページネーション、その他のAPI契約をシミュレートするために、Mock期待値にカスタムヘッダーを追加できます。

高度なレスポンスプロパティ
Mock期待値内の「詳細」タブで以下を設定できます:

HTTPステータスコード: エラーや特別なケースをシミュレート（デフォルトは200）。

レスポンス遅延: 遅いAPIレスポンスをシミュレートするために遅延を追加（ミリ秒単位）。

期待値の有効化/無効化
期待値リストからローカルおよびクラウドMock環境で各期待値を個別にオン/オフできます。

まとめ#