# HTTP リクエストとレスポンスのリファレンス

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

## レスポンスプロパティ

`response`  オブジェクトは、受信した HTTP レスポンスに関する情報（応答コンテンツ、ヘッダー、ステータスなど）を保持し、 [ヘッダー](#headers-reference)とネストされた [contentType](#content-type-reference) オブジェクトへのアクセスを提供します。

|  プロパティ  |  説明  |
| --- | --- |
|   `body`  （文字列 \| [TextStreamResponse](#textstreamresponse_reference) \| DOM ドキュメント \| オブジェクト）  |  レスポンスの内容は、文字列、TextStreamResponse オブジェクト、DOM  `Document`  、または JSON オブジェクトのいずれかになります。  |
|   `headers`  ( [ResponseHeaders](#headers-reference))  |  [応答ヘッダーストレージオブジェクト](#headers-reference)。  |
|   `status`  (整数)  |  レスポンスのステータス。たとえば、  200  または  404  です。  |
|   `contentType`  ( [ContentType](#content-type-reference))  |  [contentType オブジェクト](#content-type-reference)で、  Content-Type  応答ヘッダー値のデータを保持します。  |

## ヘッダーオブジェクト

`ResponseHeaders`  オブジェクトは、応答ヘッダーの値に関するデータを取得するために使用されます。

### メソッド

|  メソッド  |  パラメーター  |  説明  |
| --- | --- | --- |
|  valueOf  |      `headerName`  (文字列)     |      `headerName`  応答ヘッダーが存在しない場合は、  `headerName`  応答ヘッダーまたは  `null`  の最初の値を取得します。     |
|  valuesOf  |      `headerName`  (文字列)     |      `headerName`  応答ヘッダーのすべての値を含む配列を取得します。  `headerName`  レスポンスヘッダーが存在しない場合は、空の配列を返します。     |

## ContentType オブジェクト

`ContentType`  データオブジェクトには、  コンテンツタイプ 応答ヘッダーからの情報が含まれています。

### プロパティ

|  プロパティ  |  説明  |
| --- | --- |
|   `mimeType`  (文字列)  |  応答の MIME タイプ（たとえば、  テキスト / プレーン 、  text/xml 、  アプリケーション /JSON ）。  |
|   `charset`  (文字列)  |  応答文字セットの文字列表現（  UTF-8  など）。  |

## TextStreamResponse オブジェクト

`TextStreamResponse`  インターフェースは、応答をテキストストリームとして処理するために使用されます。 これにより、次の 2 つのメソッドを実装できます。

* `onEachLine(subscriber, onFinish)` 、ストリーム内の各行をループします。

* `onEachMessage(subscriber, onFinish)` : サーバーによって送信された各メッセージをサブスクライブします。 これは、WebSocket、GRPC、WebSocket 上の GraphQL に使用できます。

### 引数

|  引数  |  onEachLine での使用箇所  |  onEachMessage での使用箇所  |
| --- | --- | --- |
|   `subscriber`   |     流線を加工する関数です。 2 つの引数を取ります。        * `line` : ストリームの一部として受信された文字列または JSON オブジェクト。    * `unsubscribe` : 現在の `onEachLine` ブロックの実行を終了する関数。 特定の条件が満たされたときにストリーム処理を停止するために使用できます。    |     ストリームメッセージを処理する関数。 3 つの引数を取ります。        * `message` : ストリームの一部として受信された文字列または JSON オブジェクト。    * `unsubscribe` : 現在の `onEachMessage` ブロックの実行を終了する関数。 特定の条件が満たされたときにストリーム処理を停止するために使用できます。    * `output` (オプション): 文字列 (メッセージ) を受け取り、その引数をサーバーに送り返す関数。    |
|   `onFinish`   |  ストリームの終了後に実行される関数。  |

使用方法の例については、「 [応答処理の例](http-response-handling-examples.html)」を参照するか、  `.http`  ファイル内の   サンプル例   をクリックして   WebSocket リクエスト​​s​   または   GraphQL リクエスト​​s​   を選択してください。

## クッキー​​

HTTP クライアントは、HTTP レスポンスの  `Set-Cookie`  ヘッダーで返される Cookie を操作するためのメソッドを提供します。

|  メソッド  |  パラメーター  |  説明  |
| --- | --- | --- |
|   `response.cookies()`   |  -  |  サーバーによって設定されたすべてのクッキーの配列を返します。  |
|   `response.cookiesByName(name)`   |   `name`  (文字列)  |  指定された名前でフィルタリングされたクッキーの配列を返します。  |

これらのメソッドを使用してレスポンスから特定のクッキーを抽出し、その値を次のリクエストで再利用できます。例えば、 [クッキーを変数として保存する](http-response-handling-examples.html#cookie-in-a-variable)ことができます。 また、ログインやログアウトなどのアクション後にサーバーが期待されるクッキーを設定しているかを検証したり、デバッグ目的でクッキー属性を確認したり、自動テストフローの一部として特定のクッキーが存在することをアサートしたりできます。

## リクエストのプロパティ

`request`  オブジェクトは、HTTP 要求に関する情報を保持し、事前要求スクリプトと応答ハンドラースクリプトの両方で使用できます。

|  プロパティ  |  リクエスト前スクリプトで使用する場合  |  応答ハンドラースクリプトで使用する場合  |
| --- | --- | --- |
|   `body()`   |     次の 2 つの方法のいずれかを使用して取得した要求 [本文](exploring-http-syntax.html#provide-request-body)。        * `getRaw()` ：リクエストボディを生のフォーマットで返します。ボディに変数が含まれている場合は、値ではなく変数名が表示されます。 例： ```JAVASCRIPT client.log(request.body.getRaw()); ```    * `tryGetSubstituted()` : すべての既知の変数をそれらの値に置き換えたリクエスト本文を返します。 ```JAVASCRIPT client.log(request.body.tryGetSubstituted()); ```    |     リクエスト [本文](exploring-http-syntax.html#provide-request-body)は文字列です。 例：       ```JAVASCRIPT client.log(request.body()) ```    |
|   `environment`   |   `get(name)`  メソッドがあり、 [環境変数](http-client-variables.html#environment-variables)の値を  `name` で識別して取得するか、存在しない場合は  `null` を返します。  |
|   `headers`   |     2 つのメソッドがあります：        * `all` : 現在のリクエストのすべてのヘッダーの値を含む配列を返します。    * `findByName(name)` : `name` パラメーターによって識別されるヘッダーの値を取得します。    |
|     配列の各要素は、次のメソッドを持つリクエストヘッダーです：        * `name` : `Content-Type` などのヘッダー名。    * `getRawValue` ：ヘッダー値を生のフォーマットで返します。ヘッダーに変数が含まれている場合は、値ではなく変数名が表示されます。    * `tryGetSubstitutedValue()` : すべての既知の変数をそれらの値に置き換えたヘッダーを返します。    |     配列の各要素は、次のメソッドを持つリクエストヘッダーです：        * `name` : `Content-Type` などのヘッダー名。    * `value()` : `application/json` などのヘッダー値。    |
|   `method`   |  リクエストで使用される HTTP メソッド (GET や POST など)。 例:  `client.log(request.method)`   |
|   `url()`   |     2 つのメソッドのいずれかで取得したリクエスト URL：        * `getRaw()` ：リクエスト URL を生のフォーマットで返します。URL に変数が含まれている場合は、値ではなく変数名が表示されます。 例： ```JAVASCRIPT client.log(request.url.getRaw()); ```    * `tryGetSubstituted()` : すべての既知の変数をそれらの値に置き換えたリクエスト URL を返します。 ```JAVASCRIPT client.log(request.url.tryGetSubstituted()); ```    |     リクエスト URL を文字列として指定します。 例：       ```JAVASCRIPT client.log(request.url())  ```    |
|   `variables`   |   `get(name)`  メソッドがあり、 [リクエストごとの変数](http-client-variables.html#per_request_variables)の値を  `name` で識別して取得するか、存在しない場合は  `null` を返します。  |
|   `iteration()`   |     [現在の反復の番号（インデックス）を取得する](http-client-variables.html#iteration-example)       コレクションを表す変数の場合。     |
|   `templateValue(Integer)`   |  [ループ内のインデックスによってコレクション要素の値を取得する](http-client-variables.html#templatevalue-example)  |

