Apidog Docs

動的値モジュール

Apidogの動的値は、Faker.js v9.0.0-rc.1を基にしており、APIテストのワークフローに特化して強化・最適化されています。Faker.jsの強力な機能を保持しつつ、より直感的で効率的なテストデータ生成体験を提供します。すでにFaker.jsに慣れているなら、Apidogの動的値への移行は簡単です。

包括的な動的値ライブラリ

Apidogは、Faker.jsの構造を反映した各動的値カテゴリの例を含むドキュメントを提供しています：

Apidog動的値の主な強化点

Apidog動的値をさらに強力で使いやすくするための主な変更点を紹介します：

1. 簡略化された式構文で簡単アクセス

Apidogは、動的値を呼び出すための簡潔で直感的な構文を使用しています：

Faker.js: faker.finance.accountName()

Apidog: {{$finance.accountName}}

Apidog内で{{%と入力するだけで、自動補完が起動し、利用可能な動的値を簡単に探索できます。

2. オブジェクトと配列の出力を最適化 - 柔軟性の向上

Apidogは、Faker.jsでオブジェクトや配列を返すメソッドに対してJSON文字列を返すことで、データ処理を簡素化し、特定の値に直接アクセスできるようにします：

例1: 空港データの抽出

Faker.js: faker.airline.airport() はオブジェクトを返します：

Apidog: 特定のフィールドに直接アクセス：

例2: 複数の日付の処理

Faker.js: faker.date.betweens() は配列を返します：

Apidog: データ処理を簡単にするためにJSON文字列化された配列を返します：

調整されたメソッドとそのパラメータの包括的な概要については、Apidogのドキュメントを参照してください。

3. ローカライズされたデータ生成のためのロケール制御の強化

Apidogは、地域固有のデータを生成するためのロケール設定を強化しています：

関数レベルの設定: 各動的値関数に対して個別にロケール設定を定義。

プロジェクトレベルのデフォルト: Apidogプロジェクト全体のデフォルトロケールを設定。

日付フォーマットのオーバーライド: 日付関連の関数内でformatメソッドを使用して、ロケール固有のフォーマットオーバーライドを適用。

4. 共通ユースケースのためのプリセットパラメータ - ワークフローの効率化

Apidogは、頻繁に使用されるメソッドのためのプリセットパラメータを提供し、効率を向上させます（必要に応じてカスタマイズ可能）：

{{$helpers.fromRegExp('[A-Z0-9]{4}-[A-Z0-9]{4}')}} // 正規表現に一致する文字列を生成

{{$helpers.arrayElement(['abc','123'])}} // 配列からランダムに要素を選択

{{$helpers.arrayElements(['abc','123'])}} // 配列から複数のランダム要素を選択

{{$helpers.replaceSymbols('##??**')}} // 特殊記号をランダムな文字に置換

{{$helpers.slugify('abc 123')}} // URLに優しいSlugを生成

5. 拡張された動的値ライブラリでカバレッジを拡大

Apidogは、新しいカテゴリとメソッドでデータ生成能力を強化します：

新しいカテゴリ: food 多様な食品関連データを生成。例: {{$food.vegetable}}

新しいメソッド:

{{$date.timeZone}} タイムゾーンデータを生成。

{{$music.album}} リアルな音楽アルバム名を作成。

{{$music.artist}} アーティスト名を生成。

強化されたメソッドパラメータ:

{{$phone.number(style='human')}} 人間が読みやすい電話番号を生成、例: (555) 123-4567。

{{$number.int(multipleOf=3)}} 指定された数で割り切れる整数を生成。

6. 無制限の連結 - 創造性を解き放つ

Apidogは、Mockデータと動的値をシームレスに組み合わせることができる究極の柔軟性を提供し、豊かでリアルなテストシナリオを作成できます。

7. 拡張された日付機能で強力な日付操作

Apidogは、フォーマット、オフセット計算などの新しいパラメータを持つ日付関連の機能を拡張し、多様で複雑なテスト要件に対応します。