PhpStorm 2026.3 Help

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

レスポンスプロパティ

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

プロパティ

説明

body （文字列 | TextStreamResponse | DOM ドキュメント | オブジェクト）

レスポンスの内容は、文字列、TextStreamResponse オブジェクト、DOM Document 、または JSON オブジェクトのいずれかになります。

headers (ResponseHeaders)

応答ヘッダーストレージオブジェクト。

status (整数)

レスポンスステータス、たとえば 200 または 404。

contentType (ContentType)

レスポンスヘッダーの Content-Type の値に関するデータを保持する contentType オブジェクト。

ヘッダーオブジェクト

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

Methods

メソッド

パラメーター

説明

valueOf

ヘッダー名 (文字列)

ヘッダー名 応答ヘッダーが存在しない場合は、 ヘッダー名 応答ヘッダーまたは null の最初の値を取得します。

valuesOf

ヘッダー名 (文字列)

ヘッダー名 応答ヘッダーのすべての値を含む配列を取得します。 ヘッダー名 レスポンスヘッダーが存在しない場合は、空の配列を返します。

ContentType オブジェクト

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

プロパティ

プロパティ

説明

mimeType (文字列)

応答の MIME タイプ（たとえば、 テキスト / プレーン、 text/xml、 アプリケーション /JSON）。

charset (文字列)

応答文字セットの文字列表現（UTF-8 など）。

TextStreamResponse オブジェクト

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

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

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

引数

Argument

onEachLine での使用箇所

onEachMessage での使用箇所

subscriber

流線を加工する関数です。 2 つの引数を取ります。

  • line: ストリームの一部として受信された文字列または JSON オブジェクト。

  • unsubscribe: 現在の onEachLine ブロックの実行を終了する関数。 特定の条件が満たされたときにストリーム処理を停止するために使用できます。

ストリームメッセージを処理する関数。 3 つの引数を取ります。

  • メッセージ: ストリームの一部として受信された文字列または JSON オブジェクト。

  • unsubscribe: 現在の onEachMessage ブロックの実行を終了する関数。 特定の条件が満たされたときにストリーム処理を停止するために使用できます。

  • output (オプション): 文字列 (メッセージ) を受け取り、その引数をサーバーに送り返す関数。

onFinish

ストリームの終了後に実行される関数。

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

Cookie

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

メソッド

パラメーター

説明

response.cookies()

-

サーバーによって設定されたすべてのクッキーの配列を返します。

response.cookiesByName(name)

name (文字列)

指定された名前でフィルタリングされたクッキーの配列を返します。

これらのメソッドを使用すると、レスポンスから特定の Cookie を抽出し、以降のリクエストでその値を再利用できます。たとえば、 Cookie を変数として保存することで実現できます。 ログインやログアウトなどのアクション後にサーバーが想定どおりの Cookie を設定していることを確認したり、デバッグ目的で Cookie 属性を調べたり、自動テストフローの一部として特定の Cookie が存在することをアサートしたりすることもできます。

リクエストのプロパティ

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

プロパティ

リクエスト前スクリプトで使用する場合

応答ハンドラースクリプトで使用する場合

body()

次の 2 つの方法のいずれかを使用して取得した要求 本文。

  • getRaw(): リクエスト本文を raw フォーマットで返します: 本文に変数が含まれる場合、値の代わりに変数名が表示されます。 例:

    client.log(request.body.getRaw());

  • tryGetSubstituted(): すべての既知の変数をそれらの値に置き換えたリクエスト本文を返します。

    client.log(request.body.tryGetSubstituted());

リクエスト 本文は文字列です。 例:

client.log(request.body())

environment

name によって識別される 環境変数の値を取得するか、存在しない場合は null を返す get(name) メソッドがあります。

headers

次の 2 つの方法があります。

  • all: 現在のリクエストのすべてのヘッダーの値を含む配列を返します。

  • findByName(name): name パラメーターによって識別されるヘッダーの値を取得します。

配列の各要素は、次のメソッドを持つリクエストヘッダーです。

  • name: Content-Type などのヘッダー名。

  • getRawValue: ヘッダー値を raw フォーマットで返します: ヘッダーに変数が含まれる場合、値の代わりに変数名が表示されます。

  • tryGetSubstitutedValue(): すべての既知の変数をそれらの値に置き換えたヘッダーを返します。

配列の各要素は、次のメソッドを持つリクエストヘッダーです。

  • name: Content-Type などのヘッダー名。

  • value(): application/json などのヘッダー値。

method

リクエストで使用される HTTP メソッド (GET や POST など)。 次に例を示します: client.log(request.method)

url()

次の 2 つの方法のいずれかを使用して取得したリクエスト URL。

  • getRaw(): リクエスト URL を raw フォーマットで返します: URL に変数が含まれる場合、値の代わりに変数名が表示されます。 例:

    client.log(request.url.getRaw());

  • tryGetSubstituted(): すべての既知の変数をそれらの値に置き換えたリクエスト URL を返します。

    client.log(request.url.tryGetSubstituted());

リクエスト URL を文字列として指定します。 例:

client.log(request.url())

variables

name によって識別される リクエストごとの変数の値を取得するか、存在しない場合は null を返す get(name) メソッドがあります。

iteration()

現在の反復の番号（インデックス）を取得する

コレクションを表す変数の場合。

templateValue(Integer)

ループ内のインデックスによってコレクション要素の値を取得する

2026 年 11 月 9 日
HTTP クライアントでサポートされる JavaScript API応答処理の例