PhpStorm 2025.3 ヘルプ

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

レスポンスプロパティ

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

プロパティ

説明

body (文字列 | TextStreamResponse | オブジェクト)

応答コンテンツ。文字列、TextStreamResponse オブジェクト、または JSON オブジェクトにすることができます。

headers (ResponseHeaders)

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

status (整数)

応答ステータス。たとえば、200 または 404

contentType (ContentType)

コンテンツタイプ応答ヘッダー値のデータを保持する contentType オブジェクト

ヘッダーオブジェクト

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

メソッド

メソッド

パラメーター

説明

valueOf

headerName (文字列)

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

valuesOf

headerName (文字列)

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

ContentType オブジェクト

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

Properties

プロパティ

説明

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 ファイル内のサンプルをクリックして WebSocket リクエストまたは GraphQL リクエストを選択してください。

リクエストのプロパティ

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

プロパティ

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

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

body()

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

  • getRaw() : リクエスト本文を生の形式で返します。本文に変数が含まれている場合は、値ではなく名前が表示されます。例:

    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 : 生の形式でヘッダー値を返します。ヘッダーに変数が含まれている場合、値の代わりに変数の名前が表示されます。

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

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

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

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

method

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

url()

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

  • getRaw() : リクエスト URL を生の形式で返します。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)

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

2025 年 5 月 21 日

関連ページ:

応答処理の例

このトピックでは、いくつかの HTTP レスポンス処理の例を調べます。例を試してみるには、auth-requests および test-responses 要求のコレクションを調べましょう。応答ヘッダー、本文、コンテンツタイプの確認:この例では、次のことを確認するためにいくつかのテストを作成します。要求は正常に実行されます。つまり、応答状況は 200 です。ヘッダーはレスポンスボディ内で受信されます。レスポンスのコンテンツタイプはアプリケーション /JSON です。テストを作成するには、クライアントオブジ...

HTTP リクエスト構文の調査

このセクションでは、HTTP リクエストの形式について説明します。HTTP リクエストの送信と HTTP レスポンスの表示の詳細については、「HTTP クライアント」を参照してください。PhpStorm コードエディターで HTTP リクエストを作成するには、次の一般的な構文を使用します。Method Request-URI HTTP-Version Header-field: Header-value Request-BodyHTTP リクエストでコメントを使用するリクエスト内で、またはで任意...

HTTP クライアント変数

HTTP リクエストを作成する場合、変数を使用してその要素をパラメーター化できます。変数は、リクエストのホスト、ポート、パスの値、クエリパラメーターまたは値、ヘッダー値、リクエストの本文内または外部ファイルで使用される任意の値を保持できます。リクエスト内で変数を使用する変数をとして二重波括弧で囲みます。リクエストで波括弧を使用する必要があるが、それを HTTP クライアント変数として扱わないようにしたい場合は、URL エンコード形式を使用します。の場合は、の場合はです。例:### send UR...