# HTTP クライアント変数

> For the complete documentation index, see [llms.txt](https://www.jetbrains.com/ja-jp/help/clion/llms.txt).

HTTP リクエストを作成する場合、変数 を使用してその要素をパラメーター化できます。 変数は、リクエストのホスト、ポート、パスの値、クエリパラメーターまたは値、ヘッダー値、リクエストの本文内または外部ファイルで使用される任意の値を保持できます。

Procedure: リクエスト内で変数を使用する

* 変数を  `{{variable}}`  として二重波括弧で囲みます。

> **Note:**
> リクエストで波括弧を使用する必要があるものの、HTTP Client 変数として扱われたくない場合は、URL エンコードフォーマットを使用してください:  `%7B`  を  `{`  の代わりに、  `%7D`  を  `}`  の代わりに使用します。 例：
>
>
>
>
> ```HTTP_REQUEST_FULL
> ### send URL-encoded {{variable}}
>
> GET https://www.example.com/search?q=%7B%7Bvariable%7D%7D
>
> ```

変数名には、文字、数字、アンダースコアシンボル  `_`  、ハイフンシンボル  `-`  、またはドットシンボル  `.`  を含めることができます (変数名のドットについては [下記の注意](#note_about_dots)を参照してください)。

## 変数型

HTTP Client には複数の種類の変数があります。 スコープや優先順位によって異なります。変数の名前が競合する場合、リストの上位にある変数の値が使用されます。

* [Environment variables](#environment-variables) defined in dedicated environment files and available in any `.http` file. 名前の競合が発生した場合、パブリック変数がプライベート変数より優先されます。 `client.variables.environment` または `request.environment` を使用してアクセスします。

* [グローバル変数](http-client-reference.html#global-variables-storage-reference)は [応答ハンドラーと事前リクエストスクリプト](http-client-in-product-code-editor.html#using-response-handler-scripts)で定義されています。 `client.variables.global` または `client.global` を使用してアクセスします。

* [インプレース変数](#in-place-variables)は `.http` ファイル内で定義され、同じファイル内でのみ使用できます。 `client.variables.file` を使用してアクセスします。

* [Per-request variables](#per_request_variables) defined before a request and available only within the single request that follows. `client.variables.request` または `request.variables` を使用してアクセスします。

* さらに、HTTP クライアントは [組み込み動的変数](#dynamic-variables)に動的に生成された値を提供します。 これらの変数には予約名が付いています。

異なる型の変数の操作を簡素化するため、HTTP クライアントは単一のアクセスポイント  `client.variables`  を提供します。 このアクセスポイントをリクエスト前処理スクリプトやレスポンスハンドラースクリプトで使用することで、すべての変数スコープにアクセスできます。  `client.global`  、  `request.environment`  、  `request.variables`  などの既存のアクセスポイントも保持されます。

> **Tip:**
> Starting with version 2024.2, CLion treats all variables in HTTP requests (except for [built-in dynamic variables](#dynamic-variables)) as JSONPath expressions. これにより、 [変数値のコレクション](#collections-in-variables)にアクセスしやすくなります。 また、変数名にドット  `.`  を使用すると、HTTP クライアントはその値が JSON データと一致することを期待します。 例:  `{{client.host.url}}`  の値は、  `dev`  環境ファイルで次のように表すことができます。
>
>
>
>
> ```JSON
> {
> "dev":{
> "client": {
> "host": {
> "url": "example.org"
> }
> }
> }
> }
>
> ```
>
>
>
>
> ```HTTP_REQUEST_FULL
> # assuming an environment is selected, 'dev' in our case
>
> GET {{client.host.url}}
>
> ```
>
>
>
> 変数名にドットを含める場合は、HTTP リクエストで使用するときに引用符と角括弧で囲む必要があります。 例：
>
>
>
>
> ```JSON
> {
> "dev":{
> "client": {
> "host.url": "example.org"
> }
> }
> }
>
> ```
>
>
>
>
> ```HTTP_REQUEST_FULL
> GET {{client.['host.url']}}
>
> ```
>
>
>
> 変数で JSONPath を使用するその他の例については、 [変数内のコレクションを反復処理する](#collections-in-variables)を参照してください。

## 環境変数

環境変数を使うと、プロジェクト内に一連の環境定義を保存できます。 たとえば、リクエストでホスト名を明示的に指定する代わりに、異なる環境で  `{{host}}`  変数を作成できます: 開発環境ではローカルホスト名、本番環境ではパブリックホスト名。 その後、現在の   .http   ファイルエディター上部にある   実行   リストを使用して、環境を選択できます:

* 環境がありません : このオプションを選択すると、現在のファイルでリクエストを実行するときに環境は使用されません。 リクエストに変数が含まれていない場合は、これを選択します。

* 環境の名前（ 本番 や 開発 など）を指定すると、選択した環境が現在のファイルの全リクエストに使用され、 ![実行ボタン](https://resources.jetbrains.com/help/img/idea/2026.3/app.expui.run.run.svg) をクリックする際に毎回選択する必要がありません。 同じ環境で複数のリクエストを実行し、リクエストを実行するたびに環境を選択したくない場合に便利です。

* <実行前に環境を選択する> : このオプションを選択すると、 ![実行ボタン](https://resources.jetbrains.com/help/img/idea/2026.3/app.expui.run.run.svg) をクリックするたびに環境を選択する必要があります。 これは、環境を頻繁に切り替え、実行ごとに明示的に環境を選択して、必要な環境で要求を確実に実行する場合に便利です。

![実行リクエスト: 環境の選択](https://resources.jetbrains.com/help/img/idea/2026.3/run_request_in_env.png)

選択した環境は、リクエストの [構造を見る](analyzing-applications.html)、 [ブラウザーでのリクエストのオープン、リクエスト](http-client-in-product-code-editor.html#open_in_browser)の [実行](http-client-in-product-code-editor.html#execute_request_procedure)、および [実行 / デバッグ構成の作成](http-client-in-product-code-editor.html#http-request-run-debug-configurations)の場合に、デフォルトの環境として使用されます。

Procedure: 環境変数を定義する

環境変数は  環境ファイル で定義されます。

1. リクエストのエディターパネルの上部にある   実行   リストで、環境を追加する場所を選択します。

* 環境を公開する場合は、 環境を Public ファイルに追加… を選択します。 これにより、環境が `http-client.env.json` ファイルに追加されます。 このファイルには、ホスト名、ポート、クエリパラメーターなどの一般的な変数を含めることができ、プロジェクトと一緒に配布することを目的としています。

* 環境をプライベートにする場合は、 環境を Private ファイルに追加… を選択します。 これにより、環境が `http-client.private.env.json` ファイルに追加されます。 このファイルには、パスワード、トークン、証明書、その他の機密情報が含まれる場合があります。 `http-client.private.env.json` ファイルで指定された変数の値は、パブリック環境ファイルの値をオーバーライドします。

> **Tip:**
> 必要に応じて、これらのファイルを手動で作成できます。

2. 作成したファイルに目的の変数を入力します。

次のサンプル  `http-client.env.json`  環境ファイルは、  開発 と  本番 の 2 つの環境を定義しています。 追加の  `http-client.private.env.json`  ファイルは機密認証データを保持します。

http-client.env.json:

```JSON
{
    "development": {
        "host": "localhost",
        "id-value": 12345,
        "username": "",
        "password": "",
        "my-var": "my-dev-value"
    },

    "production": {
        "host": "example.com",
        "id-value": 6789,
        "username": "",
        "password": "",
        "my-var": "my-prod-value"
    }
}

```

http-client.private.env.json:

```JSON
{
    "development": {
        "username": "dev-user",
        "password": "dev-password"
    },

    "production": {
        "username": "user",
        "password": "password"
    }
}

```

HTTP リクエストの例は次のとおりです:

```HTTP_REQUEST
GET http://{{host}}/api/json/get?id={{id-value}}
Authorization: Basic {{username}} {{password}}
Content-Type: application/json

{
    "key": "{{my-var}}"
}

```

Before you execute the request, CLion lets you choose an execution environment using the   実行   list on top of the request's editor panel.

選択に応じて、生成されるリクエストは次のいずれかになります:

開発:

```HTTP_REQUEST
GET http://localhost/api/json/get?id=12345
Authorization: Basic dev-user dev-password
Content-Type: application/json

{
    "key": "my-dev-value"
}

```

本番:

```HTTP_REQUEST
GET http://example.com/api/json/get?id=6789
Authorization: Basic user password
Content-Type: application/json

{
    "key": "my-prod-value"
}

```

リクエストの実行時に変数が解決されない場合、CLion は通知を表示し、別の実行環境をすばやく作成、更新、または選択できるようにします。

![HTTP リクエスト通知の未解決の変数](https://resources.jetbrains.com/help/img/idea/2026.3/ps_http_client_unresolved_var.png)

> **Note:**
> IDEA で Git を使用している場合、  `http-client.private.env.json`  ファイルは Git によって追跡されません。 ただし、  `.gitignore`  ファイルには追加されません。 サードパーティ製ツールまたはターミナルから変更をコミットする場合、機密情報を共有しないようにするには、  `http-client.private.env.json`  を  `.gitignore`  に手動で追加する必要がある場合があります: ファイルを右クリックし、  `Git | .gitignore に追加する`  を選択します。

### 複数の環境ファイルを管理する

プロジェクトには、HTTP リクエストファイルと対応する環境ファイルを含む複数のディレクトリが存在する場合があります。 この場合、リクエストの環境を選択する際に次のセクションを使用できます。

* ファイルに対して は、現在のディレクトリと親ディレクトリに保存されている環境を示します。 このリストから環境を選択すると、HTTP クライアントは現在のディレクトリに保存されているファイル (パブリックおよびプライベート) 内でその環境を見つけようとします。 この環境にファイルがない場合は、親ディレクトリをチェックします。

* プロジェクト全体から は、プロジェクトの他のすべての場所 (現在のディレクトリと親ディレクトリを除く) に保存されている環境を示します。 これらのディレクトリのファイルに、 ファイルに対して セクションの環境と同じ名前の環境が含まれている場合、その環境はリストに表示されません。 プロジェクト内のどこにでも表示されるようにしたい場合は、環境に一意の名前を付けることができます。

![HTTP クライアントの環境](https://resources.jetbrains.com/help/img/idea/2026.3/http_client_environments.png)

これを例で説明してみましょう。 次のようなプロジェクト構造があるとします。

```CONSOLE
root/http-client.env.json # public file with 'dev' environment and 'host' variable
root/service1/http-client.private.env.json # private file with 'dev' environment and "key": "myKey1" variable
root/service2/http-client.private.env.json # private file with 'dev' environment and "key": "myKey2" variable

```

`service1`  ディレクトリに保存されている  `.http`  ファイルは、  `dev`  環境を選択すると、  `key`  変数の  `myKey1`  値を使用します。  `service2`  ディレクトリに保存された  `.http`  ファイルは、  `key`  変数の  `myKey2`  値を使用します。

プライベートファイルに  `host`  変数が含まれている場合、プライベートファイルはパブリックファイルよりも優先されるため、  `.http`  ファイルはその値を使用します。 それ以外の場合は、パブリックファイルの値が使用されます。

## インプレース変数

インプレース変数のスコープは、それが宣言された  `.http`  ファイルです。 同じファイル内の複数のリクエストで同じ変数を参照する場合は、インプレース変数を使用します。

インプレース変数を作成するには、HTTP メソッドセクションの上に「  `@`  」と入力し、その後に変数の名前を入力します。 例：

```HTTP_REQUEST_FULL
@myhost = example.org

GET {{myhost}}/users

###
GET {{myhost}}/stats

```

## リクエストごとの変数

`request.variables.set(variableName, variableValue)`  メソッドを使用して、HTTP 要求で使用される変数の値を設定できます。 HTTP リクエストの上に、  `{% ... %}`  でラップされたプレリクエストスクリプトを記述します。 例：

```HTTP_REQUEST_FULL
< {%
    request.variables.set("firstname", "John")
%}
GET http://example.org/{{firstname}}

```

プレリクエストスクリプトで定義された変数は、そのスクリプトに続く単一のリクエスト内でのみ使用できます。

変数の初期化   コンテキストアクション ( `Alt+Enter` (Windows), `⌥ ⏎` (macOS), `⌥ ⏎` (IntelliJ IDEA Classic (macOS)), `⌥ ⏎` (macOS System Shortcuts), `Alt+Enter` (XWin), `Alt+Enter` (GNOME), `Alt+Enter` (KDE), `Alt+Enter` (Emacs), `Alt+Enter` (Sublime Text), `⌥ ⏎` (Sublime Text (macOS)), `⌥ ⏎` (Xcode), `Alt+Enter` (Visual Studio), `⌥ ⏎` (Visual Studio (macOS)), `Alt+Enter` (ReSharper), `⌥ ⏎` (ReSharper (macOS)), `Alt+Enter` (QtCreator), `⌥ ⏎` (QtCreator (macOS)), `Alt+Enter` (NetBeans), `Ctrl+1` (Eclipse), `⌘ 1` (Eclipse (macOS)) ) を使用すると、インプレース変数または環境変数をすばやく追加したり、リクエスト前ハンドラースクリプトで変数を初期化したりできます。

![Initialize variable intention action](https://resources.jetbrains.com/help/img/idea/2026.3/http_create_pre_request_variable.animated.gif)

プレリクエストスクリプトでは、 [HTTP クライアント暗号 API](http-client-crypto-api-reference.html) を使用して、SHA-1、SHA-256、SHA-512、MD5 などの暗号化ハッシュ関数に基づいて HTTP 署名を生成し、変数としてリクエストに渡すこともできます。 例：

```HTTP_REQUEST_FULL
< {%
    const signature = crypto.hmac.sha256()
        .withTextSecret(request.environment.get("secret")) // get variable from http-client.private.env.json
        .updateWithText(request.body.tryGetSubstituted())
        .digest().toHex();
    request.variables.set("signature", signature)

    const hash = crypto.sha256()
        .updateWithText(request.body.tryGetSubstituted())
        .digest().toHex();
    request.variables.set("hash", hash)
%}
POST https://httpbin.org/post
X-My-Signature: {{signature}}
X-My-Hash: {{hash}}
Content-Type: application/json

```

## 動的変数

動的変数は、リクエストを実行するたびに値を生成します。 それらの名前は  `$`  で始まります:

* `$uuid` または `$random.uuid` : 普遍的に一意の識別子を生成します (UUID-v4)

* `$timestamp` : 現在の UNIX タイムスタンプを生成します

* `$isoTimestamp` : UTC タイムゾーンの ISO-8601 形式で現在のタイムスタンプを生成します。

* `$randomInt` : 0 〜 1000 のランダムな整数を生成します。

* `$random.integer(from, to)` : `from` (両端を含む) と `変更後` (両端を含まない) の間のランダムな整数を生成します (たとえば、random.integer(100, 500))。 パラメーターを指定しない場合は、0 ～ 1000 のランダムな整数が生成されます。

* `$random.float(from, to)` : `from` (両端を含む) と `変更後` (両端を含まない) の間のランダムな浮動小数点数を生成します (たとえば、random.float(10.5, 20.3))。 パラメーターを指定しない場合は、0 ～ 1000 のランダムな浮動小数点数が生成されます。

* `$random.alphabetic(length)` : 長さ `length` (0 より大きい必要があります) の大文字と小文字のシーケンスを生成します。

* `$random.alphanumeric(length)` : 長さ `length` (0 より大きい必要があります) の大文字と小文字、数字、アンダースコアのシーケンスを生成します。

* `$random.hexadecimal(length)` : 長さ `length` (0 より大きい必要があります) のランダムな 16 進文字列を生成します。

* `$random.email` : ランダムなメールアドレスを生成します。

* `$exampleServer` : is replaced with the CLion built-in web server, which can be accessed using HTTP Client only. この変数は、GraphQL および WebSocket の [例](http-client-in-product-code-editor.html#open-requests-collection)で使用されます。

URL パラメーターや本文などのリクエスト部分で動的変数を使用します:

```JAVASCRIPT
POST http://localhost/api/post?id={{$uuid}}

{
    "time": {{$timestamp}},
    "price": {{$random.integer(10, 1000)}},
}

```

事前リクエストハンドラースクリプトと応答ハンドラースクリプトでは、通常の JavaScript 変数と同様に、波括弧なしで使用します。 例：

```JAVASCRIPT
                < {%
const longUUID = $random.uuid
request.variables.set("generatedQuery", longUUID)
%}
GET https://examples.http-client.intellij.net/get
                ?generatedQuery={{generatedQuery}}

> {%
    client.log(`Today is ${$isoTimestamp}`)
%}
            
```

### より動的な変数

住所、色、会社名など、他の型のランダムデータを生成できます。 HTTP クライアントは、 [Java 偽者(英語)](https://javadoc.io/doc/com.github.javafaker/javafaker/latest/com/github/javafaker/package-summary.html)ライブラリの次のクラス (およびパラメーターを必要としないメソッド) をサポートしています。

* `$random.address`

* `$random.beer`

* `$random.bool`

* `$random.business`

* `$random.ChuckNorris.fact`

* `$random.code`

* `$random.color`

* `$random.commerce`

* `$random.company`

* `$random.crypto`

* `$random.educator`

* `$random.finance`

* `$random.hacker`

* `$random.idNumber`

* `$random.internet`

* `$random.lorem`

* `$random.name`

* `$random.number`

* `$random.phoneNumber`

* `$random.shakespeare`

* `$random.superhero`

* `$random.team`

* `$random.university`

> **Tip:**
> 使用可能な変数の提案を取得するには、「  `{{$random.}}`  」と入力し始めます。

#### 動的変数の局所化

デフォルトでは、HTTP クライアントは [Java 偽者(英語)](https://javadoc.io/doc/com.github.javafaker/javafaker/latest/com/github/javafaker/package-summary.html)ライブラリのデフォルトロケール（英語、米国）を使用してランダムデータを生成します。 例: 次のリクエスト

```JAVASCRIPT
                        @test = {{$random.address.fullAddress}}
###
< {%
    console.log($random.address.fullAddress)
%}

GET https://examples.http-client.intellij.net/get
                    
```

デフォルトのロケールに従ってフォーマットされたランダムなアドレスを生成します:  `Apt. 123 Main Street, Springfield, IL 12345`

地域固有のデータを生成するには、  `locale`  修飾子を使用して [サポートされているロケールのいずれか(英語)](https://github.com/DiUS/java-faker?tab=readme-ov-file#supported-locales)を明示的に指定できます。

```JAVASCRIPT
                        @testName = {{$random.locale.name.fullName("fr")}}
@testAddress = {{$random.locale.address.fullAddress("fr")}}
@testPhone = {{$random.locale.phoneNumber.cellPhone("fr")}}

< {%
    console.log("Name:", client.variables.file.get("testName"))
    console.log("Address:", client.variables.file.get("testAddress"))
    console.log("Phone:", client.variables.file.get("testPhone"))
%}

POST https://httpbin.org/post
Content-Type: application/json

{
  "name": "{{testName}}",
  "address": "{{testAddress}}",
  "phone": "{{testPhone}}"
}
                    
```

[乱数シード(英語)](https://en.wikipedia.org/wiki/Random_seed)を指定することで、ローカライズされた乱数値を決定論的にすることができます。 同じシードとロケールを使用すると、実行ごとに同じ値が生成されます。

次の例では、  `12`  は乱数発生器を初期化するために使用される乱数シードです。

```JAVASCRIPT
@testName = {{$random.locale.name.fullName("fr", 12)}}

```

## システム環境変数

HTTP Client では、オペレーティングシステムの環境変数を使用できます。

それらにアクセスするには、  `{{$env.ENV_VAR}}`  構文を使用してください。ここで  `ENV_VAR`  は環境変数の名前です。 事前リクエストハンドラースクリプトと応答ハンドラースクリプトでは、通常の JavaScript 変数と同様に、波括弧なしで使用します。 例：

```HTTP_REQUEST_FULL
GET http://localhost:63345/{{$env.USER}}

> {%
    const myUser = $env.USER
    client.log(myUser)
%}

```

使用可能な変数の候補を表示するには、変数名の入力を開始します:

![HTTP クライアントのシステム環境変数](https://resources.jetbrains.com/help/img/idea/2026.3/http_client_system_environment_variables.png)

## 変数内のコレクションを反復処理する

[環境変数](#environment-variables)と [プレリクエストスクリプトで初期化された変数](#per_request_variables)は、ID やユーザー名のリストなど、要素のコレクションを表すことができます。 このような変数が HTTP リクエストで使用されると、HTTP クライアントはこのリストの各要素に対して個別のリクエストを送信します。 CLion は、このような変数に対する JSONPath 式もサポートしているため、特定の要素または要素のサブセットにアクセスし、それぞれにリクエストを送信できます。

たとえば、ID によって書籍に関する情報を返すサーバーがある場合、JSON 配列  `[1,2,3,4,5]`  を変数  `id`  に割り当て、それを本文または URL 部分で使用できます。

```HTTP_REQUEST_FULL
< {%
    request.variables.set("id", [1,2,3,4,5])
%}
GET http://localhost:8080/books/{{id}}

```

HTTP Client は連続する 5 件のリクエストを送信し、各リクエストで変数をコレクション内の次の項目に置き換えます。

同様に、リクエスト本文でコレクションを使用することもできます。 次の例では、HTTP クライアントは本文に異なる値を持つ 3 つのリクエストを送信します:  `name: Alice`  、  `name: Bob`  、  `name: Charlie`

```HTTP_REQUEST_FULL
< {%
    request.variables.set("name", ["Alice", "Bob", "Charlie"])
%}
GET http://localhost:8080/users
Content-Type: application/json

{
  "name": {{name}}
}

```

JSONPath を使用すると、配列内の JSON オブジェクトの特定のパラメーターにアクセスすることもできます。 例: 次のクエリでは、HTTP クライアントは、  `users`  という変数内のすべてのオブジェクトの各  `name`  値に対するリクエストを送信します。

CLion は、変数で JSONPath を使いやすくするために、既知の JSON オブジェクトパラメーターの補完、検証、ハイライトなどの JSONPath コーディング支援を提供します。 JSONPath 言語は、すべての HTTP Client 変数 (double 波括弧で囲まれたもの) に [挿入](using-language-injections.html)されますが、 [動的変数](#dynamic-variables)は除きます。

```HTTP_REQUEST_FULL
GET http://localhost:8080/users/{{users[*].name}}

```

![変数内のコレクションを反復処理する](https://resources.jetbrains.com/help/img/idea/2026.3/http_client_iterate_over_collections_in_variables.png)

事前リクエストスクリプトおよび応答ハンドラースクリプトのループ内の現在のインデックスを取得するには、  `request.iteration()`  メソッドを使用します。 例:  `0`  は、配列の最初の項目が処理され、最初のリクエストが送信されていることを示します。

### request.iteration() の例

```HTTP_REQUEST_FULL
### Use request.iteration()
< {%
    request.variables.set("clients", [ // test data
        {"id": 1, "firstName": "George", "lastName": "Franklin", balance: 100},
        {"id": 2, "firstName": "John", "lastName": "Doe", balance: 1500},
        {"id": 3, "firstName": "Eduardo", "lastName": "Rodriquez", balance: 10}
    ])
%}

POST https://examples.http-client.intellij.net/post
        Content-Type: application/json

{
  "clientId": {{$.clients..id}},
  "firstName": "{{$.clients..firstName}}",
  "lastName": "{{$.clients..lastName}}",
  "balance": "{{$.clients..balance}}"
}

> {%
  client.log(request.iteration()) // prints 0 for 1st request, 1 for 2nd, 2 for 3rd
  let current = request.variables.get("clients")[request.iteration()]
  client.test(`Account ${current.lastName} has initial balance ${current.balance}`, () => {
    let responseBalance = jsonPath(response.body, "$.json.balance")
    client.assert(responseBalance == current.balance)
  })
%}

```

事前リクエストスクリプトおよび応答ハンドラースクリプトのループ内でインデックスによって値を取得するには、  `request.templateValue(Integer)`  メソッドを使用します。

### request.templateValue() の例

```HTTP_REQUEST_FULL
### Use templateValue

< {%
    request.variables.set("books", [{
    "books": {
      "title": "Ulysses",
      "year": 1922
    }
  },
  {
    "books": {
      "title": "Dune",
      "year": 1965
    }}])
%}

GET http://localhost:8080/books
Content-Type: application/json

{
  "bookTitle": "{{$.books..title}}",
  "bookYear": "{{$.books..year}}"
}

> {%
  let bookTitle = request.templateValue(0)
  client.log(`book title is: ${bookTitle}`) // prints Ulysses in 1st request, Dune in 2nd
  client.log(request.iteration())

  let bookYear = request.templateValue(1)
  client.log(`book year is: ${bookYear}`) // prints 1922 in 1st request, 1965 in 2nd

%}

```

