RubyMine 2026.3 Help

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

レスポンスプロパティ

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

プロパティ

説明

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

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

ヘッダー (ResponseHeaders)

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

ステータス (整数)

レスポンスステータス。例えば、 200 や 404。

コンテンツタイプ (ContentType)

contentType オブジェクトは、 Content-Type 応答ヘッダー値のデータを保持します。

ヘッダーオブジェクト

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

メソッド

メソッド

パラメーター

説明

valueOf

ヘッダー名 (文字列)

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

valuesOf

ヘッダー名 (文字列)

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

ContentType オブジェクト

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

プロパティ

プロパティ

説明

MIME タイプ (文字列)

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

文字セット (文字列)

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

TextStreamResponse オブジェクト

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

  • 各行で(契約者、完了時) 、ストリーム内の各行をループします。

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

引数

引数

onEachLine での使用箇所

onEachMessage での使用箇所

契約者

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

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

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

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

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

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

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

完了時

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

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

クッキー

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

メソッド

パラメーター

説明

レスポンスの Cookie()

-

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

名前別のレスポンス Cookie(name)

名前 (文字列)

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

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

リクエストのプロパティ

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

プロパティ

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

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

本文()

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

  • 未加工値を取得() ：リクエストボディを生のフォーマットで返します。ボディに変数が含まれている場合は、その値の代わりに名前が表示されます。 例：

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

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

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

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

client.log(request.body())

環境

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

ヘッダー

2 つのメソッドがあります：

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

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

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

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

  • 未加工値を取得 ：ヘッダー値を生のフォーマットで返します。ヘッダーに変数が含まれている場合は、その値の代わりに名前が表示されます。

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

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

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

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

メソッド

リクエストで使用される HTTP メソッド (GET や POST など)。 例: クライアント.ログ(リクエスト.メソッド)

URL()

2 つのメソッドのいずれかを使用して取得したリクエスト URL：

  • 未加工値を取得() ：リクエスト URL を生のフォーマットで返します。URL に変数が含まれている場合は、その値の代わりに名前が表示されます。 例：

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

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

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

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

client.log(request.url())

変数

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

反復()

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

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

テンプレート値(Integer)

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

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