# HTTP クライアントリファレンス

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

`client`  オブジェクトは、HTTP クライアントセッションのメタデータへのアクセスを提供し、HTTP レスポンスと出力内の  `[ログ](#log)`  テキストを  `[テスト](#test)`  で変換します。 このオブジェクトは CLion が起動するたびに再初期化され、CLion の再起動間ではデータは保持されません。

`client`  オブジェクトは、変数ストレージとして機能するネストされた [グローバル](#global-variables-storage-reference)オブジェクトも公開します。

## メソッド

### test

名前が  `テスト名`  で本体が  `機能`  のテストを作成します。 すべてのテストは、応答ハンドラースクリプトの後に実行されます。 テスト結果は、   サービス   ツールウィンドウの   テスト   タブに表示されます。

|  パラメーター  |  タイプ  |  説明  |
| --- | --- | --- |
|  テスト名  |  String  |  テスト名  |
|  機能  |  関数  |  HTTP 応答をテストする JavaScript 関数  |

### assert

指定された  `condition`  が  `true`  であることを確認し、そうでない場合は例外をスローします。 省略可能な  `message`  パラメーターは、例外メッセージとして利用されます。

|  パラメーター  |  タイプ  |  説明  |
| --- | --- | --- |
|  condition  |  ブール型​  |  レスポンスで確認する条件  |
|  message  |  String  |  条件が false と評価された場合に返されるオプションのメッセージ。  |

### ログ

応答ハンドラーまたは事前要求スクリプトの出力に  `text`  を出力し、行を終了します。

|  パラメーター  |  タイプ  |  説明  |
| --- | --- | --- |
|  text  |  String  |  応答ハンドラーまたは事前要求スクリプトの出力に出力されるテキスト。  |

### 終了

応答ハンドラースクリプトの実行を終了します。

## プロパティ

### グローバル​タイトル​

[グローバル変数ストレージ](#global-variables-storage-reference)は、グローバル変数やヘッダーの設定および削除に使用されます。

グローバル変数 (  `client.global.set(VariableName, VariableValue)`  ) に値を割り当てると、後続の HTTP 要求で  `{{VariableName}}`  として、または応答ハンドラースクリプトと事前要求スクリプトで  `client.global.get("VariableName")`  を使用して、その値にアクセスできます。 詳細な例については、 [グローバル変数を使用する](http-response-handling-examples.html#script-var-example)を参照してください。

## グローバル変数とヘッダー

`グローバル​タイトル​`  オブジェクトを使用すると、次のことが可能になります。

* グローバル変数を設定および取得します。

* グローバルヘッダーを設定します。 グローバルヘッダーを使用すると、複数の HTTP リクエストで同じヘッダーが繰り返し初期化されるのを防ぐことができます。 一度設定すると、同じ実行フロー内の後続のすべてのリクエストに暗黙的に適用されます。 グローバルヘッダーは永続的な状態を保存することを目的としたものではありません。 単一の実行フローに限定され、ヘッダーの再利用を簡素化するように設計されています。 > **Tip:** > HTTP クライアントでは、実行フローは単一のリクエストブロックで構成されます。 各ブロックには、リクエスト前スクリプト（オプション）、リクエスト自体、レスポンスハンドラー（オプション）が含まれる場合があります。

### 設定​タイトル​

変数を  `変数名`  という名前でストレージに保存し、その値を  `varValue`  に設定します。 詳細な例については、 [グローバル変数を使用する](http-response-handling-examples.html#script-var-example)を参照してください。

|  パラメーター  |  タイプ  |  説明  |
| --- | --- | --- |
|  変数名  |  String  |  グローバルストレージに保存される変数の名前。  |
|  varValue  |  String  |  グローバルストレージに保存される変数値。  |

### get

`変数名`  変数の値を返します。

|  パラメーター  |  タイプ  |  説明  |
| --- | --- | --- |
|  変数名  |  String  |  返される変数の名前。  |

### isEmpty

`グローバル​タイトル​`  オブジェクトに変数が定義されていないかどうかを確認します。

### クリア

変数ストレージから  `変数名`  変数を削除します。

|  パラメーター  |  タイプ  |  説明  |
| --- | --- | --- |
|  変数名  |  String  |  削除する変数の名前。  |

### すべてクリア

変数ストレージからすべての変数を削除します。

### headers.set

`client.global.headers.set(headerName, headerValue)`  を使用して、  `ヘッダー値`  に  `headerName`  ヘッダーを追加します。 例：

```HTTP_REQUEST_FULL
client.global.headers.set("X-Our-Header-1", "value1")

```

レスポンスハンドラースクリプトで使用する場合、ヘッダーは後続のすべての HTTP リクエストに適用されます。 プリリクエストスクリプトで使用する場合、ヘッダーは現在の HTTP リクエストと後続のすべてのリクエストに適用されます。

|  パラメーター  |  タイプ  |  説明  |
| --- | --- | --- |
|  headerName  |  String  |  HTTP リクエストで使用されるヘッダーの名前。  |
|  ヘッダー値  |  String  |  ヘッダーの値。  |

ヘッダーを削除するには、値として  `null`  を使用します。

```HTTP_REQUEST_FULL
client.global.headers.clear(headerName, null))

```

