変数の使用

Apidog では、変数を使用することで、値を簡単に保存して再利用できます。値を変数として保存すると、さまざまな環境、リクエスト、スクリプト、テストシナリオ全体でその値にアクセスできます。変数を活用することで、生産性が向上し、同僚とのチームワークも促進されます。

変数とは

変数とは、必要になるたびに手動で入力しなくても値を取得できる、データの記号的な表現です。同じ値を複数の場所で再利用する場合に便利です。

例:
複数のリクエストで同じトークンを使用しており、将来的に変更される可能性がある場合は、そのトークンを {{my_token}} という名前の変数として保存します。リクエストパラメータ値で {{my_token}} を使用します。トークンが変更された場合、変数の値を更新すると、すべての場所で更新されます。

変数は、パラメータ値、ボディ、URL、またはヘッダーで有効になります。

Apidog の Tests モジュールでは、変数を使用してリクエスト間でデータを渡すことができます。

変数のスコープ

Apidog は、さまざまな開発、テスト、コラボレーション要件に対応するために、複数のスコープの変数をサポートしています。

優先度（低い順から高い順）: Global < Module < Environment < Data < Local

同じ名前の変数が異なるスコープで定義されている場合、最も狭いスコープの値が優先されます。

グローバル変数

プロジェクト内で共有: プロジェクト全体でアクセスできます。エンドポイント間でデータを共有する場合（例: ログイントークン）に便利です。

チーム内で共有: 異なるプロジェクトをまたいでチーム全体で共有されます（例: ログインプロジェクトと財務プロジェクト間で共有されるトークン）。

NOTE

権限: チーム変数を管理するには、チーム管理者権限が必要です。Team Resources > Variables に移動してください。

スクリプト: スクリプト内で pm.globals.set を使用してローカル値を更新できますが、名前や共有値は変更できません。

モジュール変数

モジュール内で定義されます。Postman の「Collection variables」からインポートすると、モジュール変数にマッピングされます。

環境変数

特定の環境（Development、Testing、Production）に紐づけられます。有効になるのは、現在アクティブな環境の変数のみです。

データ変数

Test Scenarios または CLI で外部の CSV または JSON ファイルから取得されます。実行後、値は保持されません。

ローカル変数

単一のリクエストまたはテストシナリオの実行に限定される一時的な変数です。完了すると消えます。

TIP

Apidog の変数は 文字列として保存されます。オブジェクトや配列を保存する場合は、保存時に JSON.stringify() を使用し、取得時に JSON.parse() を使用してください。

共有値とローカル値

各変数には 2 つの状態があります。

共有値: Apidog サーバーと同期され、チームと共有されます。

ローカル値: お使いのブラウザーまたはクライアントのキャッシュにローカルに保存されます。共有されません。

ベストプラクティス:

機密データ（トークン、パスワード）には ローカル値を使用し、ご自身の端末上に保持してください。

ローカル値を空のままにすると、共有値にフォールバックします。

リンクアイコン 🔗 をクリックすると、ローカル値を共有値と同期できます。

WARNING

Apidog のキャッシュを削除すると、ローカル値も削除されます。

デバイスを切り替える際、ローカル値は自動的には移行されません（環境のエクスポート/インポートを使用してください）。

Apidog CLI で変数を使用する

CLI で実行する場合、デフォルトでは 共有値が使用されます。一方、クライアントではローカル値が使用されます。これは、クライアント実行と CLI 実行の間で不一致が発生する一般的な原因です。

TIP

Apidog CLI の詳細をご確認ください。

変数の定義

1. 環境管理（プリセット）

グローバル変数および環境変数の値は、手動で事前設定できます。

Environment Management アイコン ≡ をクリックします。

Global Variables または特定の環境を選択します。

変数名、共有値、ローカル値を追加します。

Save をクリックします。

2. 変数の抽出

コードを書かずに、API レスポンスから値を視覚的に抽出して変数に格納できます。

Run タブ（Design Mode）で、Post Processors に移動します。

Extract Variable を選択します。

抽出元（JSON、XML、Header など）と JSONPath を設定します。

リクエストを送信して実行し、Console で確認します。

TIP

Extract Variable の詳細をご確認ください。

3. スクリプト

Pre/Post-processors で pm オブジェクトを使用します。

set の構文:

オブジェクト/配列の保存:

TIP

Script Syntax の詳細をご確認ください。

4. データベース操作

データベースに接続してデータを取得し、変数として設定できます。

Post Processors に Database Operation を追加します。

データベース接続を設定します。

SQL コマンドを入力します（{{variable}} をサポート）。

Extract Result To Variable を設定します。

TIP

Database Operations の詳細をご確認ください。

リクエストパラメータ

URL、パラメータ、ヘッダー、またはボディで二重波括弧 {{variable}} を使用します。

URL の例:
http://127.0.0.1/pet/findByStatus?status={{CurrentStatus}}

JSON ボディの例:

{
    "status": "{{CurrentStatus}}",
    "quantity": {{TotalPet}}
}

WARNING

文字列: 文字列の場合は、変数を二重引用符 "" で囲んでください（例: "{{name}}"）。

数値/真偽値: 引用符を追加しないでください（例: {{count}}）。

サブ要素へのアクセス

変数に JSON オブジェクト/配列が含まれている場合は、JSONPath を使用して、ドット記法でプロパティにアクセスします。

{{user}} 内のオブジェクト:

{ "id": 1, "name": "Jack" }

リクエスト: {{user.name}}

スクリプト: pm.variables.get("user.name")

{{users}} 内の配列:

[ { "name": "Jack" } ]

リクエスト: {{users[0].name}}

スクリプト: pm.variables.get("users[0].name")

スクリプトで変数を使用する

スクリプトでは、{{}} ではなく pm.*.get() を使用します。

ログ出力:

出力を確認するには、Console タブを確認してください。

データ変数の使用

Test Scenarios で CSV/JSON ファイルをインポートすると、「データ変数」が作成されます。それらを参照するには {{column_name}} を使用します。ファイル内の各行により、個別のイテレーションがトリガーされます。

TIP

Data Driven Testing の詳細をご確認ください。

FAQ

Q: モックで変数を使用できますか？

いいえ。 変数は、リクエストが送信されたときに解決されます。モックは静的な定義であるか、クライアント側の「送信」コンテキストを同じようには持たないモックサーバー上で実行されます。

Q: スクリプトでベース URL を取得するにはどうすればよいですか？

pm.request.getBaseUrl() を使用します。

デフォルト以外のサーバーエンドポイントでは不正確になる可能性があるため、pm.environment.get('BASE_URL') は避けてください。

変数の使用

変数とは#

変数のスコープ#

共有値とローカル値#

Apidog CLI で変数を使用する#

変数の定義#

1. 環境管理（プリセット）#

2. 変数の抽出#

3. スクリプト#

4. データベース操作#