変数の使い方

データベース操作に名前を付け、データベース接続を設定します。データベース接続について詳しく学ぶ。

SQLコマンドを入力します。コマンド内で{{variables}}を使用することができます。

:::highlight purple
データベース操作について詳しく学ぶ。
:::

変数の使用

Apidogでは、プロジェクト全体で変数を参照するために二重中括弧を使用できます。例えば、リクエストの認証設定で"username"という名前の変数を参照するには、変数名を二重中括弧で囲んで{{my_variable}}のようにします。

APIを実行すると、Apidogは変数を解決し、その現在の値に置き換えます。

例えば、変数が参照されているリクエストURLでは、次のようになります：

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

Apidogはリクエストを実行する際にCurrentStatus変数の保存された値を使用します。CurrentStatusの値が"available"の場合、リクエストは次のクエリパラメータを含むURLに送信されます：

http://127.0.0.1/pet/findByStatus?status=available

"実際のリクエスト"タブで組み立てられたリクエストを確認できます。

リクエストボディ内で変数を参照する場合、参照を二重引用符で囲みます：

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

:::tip[]

• JSON形式で文字列型の変数を使用する場合は、二重引用符が必要です。他の型には二重引用符を追加しないでください。上記の例を参照してください。

• 二重中括弧は、時々不正なJSON形式の警告を引き起こすことがあります。これらの警告は無視して構いません。
  :::

変数は、リクエストURL、パラメータ、ヘッダー、認証設定、リクエストボディ、ヘッダープリセットで使用できます。

時々、"未解決の変数"通知が表示されることがあります。これは、変数が環境またはグローバル変数で定義されていないことを示しています。ただし、これは必ずしも問題ではありません。後処理で変数を抽出したり、スクリプトを使用して変数を設定している場合、リクエストを実行する前に値が取得されない可能性があります。ローカル変数の場合、実行後に期限切れになる可能性があり、その結果、変数の値が利用できなくなります。したがって、問題があるかどうかを確認するために、最初にリクエストを送信して確認してください。

変数のサブ要素の値にアクセスする

変数の値がオブジェクトまたは配列の形式である場合、変数内の属性の値を{{variableName.attributeName}}または{{variableName[0].attributeName}}で読み取ることができます。例えば：

1. オブジェクト変数userは次のようになります：

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

• APIパラメータでuserオブジェクトのnameプロパティを{{user.name}}として参照できます。
• カスタマイズされたスクリプトでuserオブジェクトのnameプロパティをpm.variables.get("user.name")として参照できます。

2. 配列変数userは次のようになります：

[
  {
    id: 1,
    name: "jack",
  },
];

• APIパラメータでuser配列の最初の要素のnameプロパティを{{user[0].name}}として参照できます。
• カスタマイズされたスクリプトでuser配列の最初の要素のnameプロパティをpm.variables.get("user[0].name")として参照できます。

変数（オブジェクトまたは配列）のプロパティの値を{{user.name}}として読み取ることは、JSONPath構文仕様に従います。JSONPathの\記号を変数名で置き換えることができます。

JSONPathの詳細を確認する。

スクリプトでの変数の使用

スクリプトで変数を使用する場合、{{variable}}の構文を直接使用することはできません。代わりに、getメソッドを使用して変数の値を変数に割り当てる必要があります。以下はその例です：

var name = pm.environment.get("variable");

getの構文についての詳細：

1. 環境変数

// 環境変数を取得する
var variable_key = pm.environment.get('variable_key');

環境変数は、配列、オブジェクト、文字列など、さまざまな形式のデータを保存できます。オブジェクトや配列のような非文字列データの場合、JSON.stringifyを使用して適切に保存する必要があります：

// 配列を保存する  
var array = [1, 2, 3, 4];  
pm.environment.set('array', JSON.stringify(array));  

// オブジェクトを保存する  
var obj = { a: [1, 2, 3, 4], b: { c: 'val' } };  
pm.environment.set('obj', JSON.stringify(obj));  

このようなデータを取得する際には、JSON.parseを使用して元の形式に戻す必要があります：

try {  
  var array = JSON.parse(pm.environment.get('array'));  
  var obj = JSON.parse(pm.environment.get('obj'));  
} catch (e) {  
  // 例外を処理する  
}

2. グローバル変数

• プロジェクト内で共有されるグローバル変数：

// プロジェクト内で共有されるグローバル変数を取得する
var variable_key = pm.globals.get('variable_key');

• チーム内で共有されるグローバル変数：

// チーム内で共有されるグローバル変数を取得する
var variable_key = pm.globals.get('variable_key', 'TEAM');

3. ローカル変数

// ローカル変数を取得する
var variable_key = pm.variables.get('variable_key');

変数のログ記録

リクエストの実行中にApidogコンソールに変数の値をログとして記録できます。

スクリプト内で変数の値をログに記録するには、次の構文を使用します：

console.log(pm.variables.get("variable_key"));

ログの結果を表示するには、レスポンスセクションのコンソールタブをクリックします。

データ変数の使用

Apidogでは、リクエストパラメータとして送信する必要がある複数のデータセットがある場合、データ変数機能を利用できます。テストシナリオでは、CSVまたはJSON形式のデータをインポートできます。その後、これらのデータ変数を{{variable_name}}として参照できます。変数名はCSVの列名に対応します。

テストシナリオでこのテストデータセットを選択すると、実行時に{{variables}}の値が実際のデータに置き換えられます。各データ行が1回の実行に対応し、テストレポートで各実行のリクエストとレスポンスを確認できます。

:::highlight purple
データ駆動型テストのガイドを参照して詳細を確認してください。
:::

FAQ

Q: モックで変数を参照できますか？変数を使用できるシナリオはどのようなものですか？

A: 変数はリクエストが送信されるときにのみ実際の値になります。これは、変数が使用できるシナリオと使用できないシナリオがあることを意味します。

変数を使用できるシナリオ：

• リクエスト：リクエストパラメータ、ボディ、パス、認証などの場所で{{variable}}を直接使用できます。
• 前処理および後処理スクリプト：これらのスクリプトでは、pm.environment.get("variablename")や類似の文を使用して変数を参照できますが、{{variable}}を直接使用することはできません。
• テストシナリオ：テストシナリオ内のリクエストは送信されるため、リクエストとスクリプトと同じです。

変数を使用できないシナリオ：

• API仕様：リクエストのデフォルト値、レスポンスのデフォルト値およびモックでは変数を使用できません。
• モック：高度なモックおよびモックスクリプトでは変数の使用をサポートしていません。

重要な注意点：

• 変数の値を別の変数に設定しないでください。それは変数の値を正しく解決する際に問題を引き起こす可能性があります。

重要なポイントは、変数は実際のリクエストが行われるときにのみ解決されるということです。API定義の静的な部分やモックシナリオでは使用できません。これらはリクエストが送信されることを伴わないためです。