HTTP クライアント

HTTP クライアントプラグインを使えば、RubyMine コードエディターで直接 HTTP リクエストの作成・編集・実行が可能です。

HTTP リクエストを作成して実行する主なユースケースは次の 2 つです：

RESTful Web サービスを開発していて、それが期待どおりに機能し、仕様に準拠してアクセス可能であり、正しく応答することを確認したい場合。
RESTful Web サービスに対応するアプリケーションを開発している場合。この場合、開発を開始する前にサービスへのアクセスと必要な入力データを調査すると役立ちます。開発中に、アプリケーションの外部からこの Web サービスを呼び出すこともできます。これは、コード内で論理エラーが検出されないにもかかわらず、アプリケーションで予期しない出力が発生し、Web サービスとの対話がボトルネックであると疑われる場合に、エラーを特定できます。

HTTP リクエストは .http および .rest ファイルに保存され、アイコンでマークされます。

HTTP ファイルのサポートには、次の機能が含まれます：

コードのハイライト
コード補完は、 OpenAPI で定義されたホスト、メソッドタイプ、ヘッダーフィールド、エンドポイントに対応しています
リクエスト、そのパーツ、レスポンスハンドラースクリプトに対するコードの折りたたみ
リクエストを HTTP リクエストコードスタイルに従って整形します。
リクエストヘッダーフィールドとドキュメントタグのインラインドキュメント
HTTP リクエストファイルの構造を見る
要求メッセージ本体内の Web 言語での言語インジェクション
ライブテンプレート

必要に応じて、開始前に HTTP プロキシページ（設定ダイアログ、 Ctrl+Alt+S ）でプロキシ設定を行ってください。

HTTP リクエストファイルを作成する

スクラッチファイルまたは HTTP リクエストタイプの物理ファイルから HTTP リクエストを処理できます。各ファイルには複数の要求を含めることができ、必要な数のファイルを作成できます。

スクラッチファイルは開発中の HTTP リクエストのテストに使えます。スクラッチファイルはプロジェクト内に保存されず、RubyMineが自由に編集・追加情報を付与できます。スクラッチファイルから HTTP リクエストを実行した場合、リクエストの下やリクエスト履歴ファイル上部にレスポンス出力ファイルへのリンクが追加されます。

HTTP リクエストスクラッチファイルを作成する

Ctrl+Alt+Shift+Insert を押して HTTP リクエストを選択します。

コントローラーアクションから HTTP 要求を作成する

URL パスインレイヒントを使用して、コントローラーアクションから HTTP 要求スクラッチファイルを生成できます。

必要なコントローラーアクションの上にあるインレイヒントをクリックし、 URL のアクションダイアログで HTTP Client でリクエストを生成するを選択します。
URL パスインレイヒントを有効または無効にするには、 Settings | Editor | Inlay hints に移動し、 URL パスチェックボックスを切り替えます。

物理ファイルは、HTTP リクエストの文書化、テスト、検証に使用できます。物理ファイルはプロジェクト内に保存され、RubyMineによる自動編集はありません。物理ファイルから HTTP リクエストが実行された場合、このファイルは変更されません。実行されたリクエストに関する情報とレスポンス出力ファイルへのリンクは、リクエスト履歴ファイルの先頭に追加されます。

物理 HTTP リクエストファイルを作成する

ファイルメニューで新規をポイントし、 HTTP リクエストをクリックします。

HTTP リクエストを移動する

F6 リファクタリング移動を使用して、HTTP リクエストをスクラッチから物理ファイルに移動したり、物理ファイル間で移動したりできます。

エディターで、移動したいリクエストにキャレットを置き、次のいずれかを実行します：
- メインメニューまたはコンテキストメニューから、リファクタリング | 移動を選択します。
- Alt+Enter を押し、 HTTP リクエストの移動インテンションアクションを選択します。
- F6 を押す。
開いた HTTP リクエストの移動ダイアログで、次の手順を実行します。
1. パスフィールドで、リストから既存の .http ファイルを選択するか、をクリックしてファイルを指定します。
  ファイルへのフルパスを手動で入力することもできます。存在しないファイルの名前を指定すると、指定した名前の新しいファイルが自動的に作成されます。
2. 要求リストで、移動したいリクエストの横にあるチェックボックスをオンにします。

HTTP リクエストを作成する

RubyMine はエディターの HTTP リクエストフォーマットを使って、HTTP リクエストの作成、実行、および情報の保存を簡単に行えます。以下の一般的な構文で、作成された HTTP リクエストファイルに直接記述できます：

        ###
        Method Request-URI HTTP-Version
        Header-field: Header-value

        Request-Body

### セパレーターの後に、 # または // で始まるコメントを入力できます。

HTTP リクエストの作成を高速化するには、次のことができます：

ツール | HTTP クライアント | HTTP クライアントでリクエストを作成をクリックしてください。リクエストファイルがエディターで開かれると、開かれたファイルにリクエストテンプレートが追加されます。それ以外の場合は、新しい .http スクラッチファイルが作成されます。
リクエストのエディターパネルの上部にあるをクリックします。ポップアップメニューで追加するリクエストタイプを選びます。

またはライブテンプレートを利用できます。エディターで Ctrl+J を押すと、利用可能なテンプレートが一覧表示されます。たとえば gtr はシンプルな GET リクエスト、 mptr は multipart/form-data POST リクエストとして展開されます。

application/x-www-form-urlencoded コンテンツタイプを使用する場合は、リクエスト本文のキーと値内の %、 &、 =、 + 特殊文字をエスケープするために % を使用する必要があります。

例: サーバーが field1=value%2Bvalue&field2=value%26value (%2B は + に対応し、 %26 は & に対応) を受信する場合、リクエスト本体は次のようになります。

                POST https://ijhttp-examples.jetbrains.com/post
                Content-Type: application/x-www-form-urlencoded

                field1=value%+value&field2=value%&value

または、エンコードされた値をすぐに書き込むこともできます。たとえば、 value1 value2 の場合は value1%ADvalue2、 value1+value2 の場合は value1%2Bvalue2 です。

カスタム HTTP メソッドを作成する

Web サービスでカスタム HTTP メソッドが必要な場合は、RubyMineに追加してHTTP リクエストで利用できます。

.http ファイルで、カスタムメソッドを大文字で入力します。
この方法が不明としてハイライトされたら、 Alt+Enter (コンテキストアクションの表示) を押してカスタム HTTP メソッドを追加するを選択します。

RubyMineはこれを有効な HTTP メソッドとして認識します。すべてのカスタム HTTP メソッド (および新しいメソッドの追加) は、IDE 設定 (Ctrl+Alt+S) のツール | HTTP クライアント | カスタム HTTP メソッドにあります。

HTTP/2

バージョン 2024.1 以降、RubyMineは HTTP リクエストで HTTP/2 をサポートします。 URL 部分の後に HTTP バージョンを指定できます。例：

GET https://example.org HTTP/2

バージョンが指定されていない場合、HTTP クライアントは安全な接続には HTTP/2 を使用し（HTTP/2 のネゴシエーションが失敗した場合は HTTP/1.1 にフォールバック）、安全でない接続には HTTP/1.1 を使用します。

HTTP バージョンを選択

リクエスト URL の後に空白を入れて Ctrl+Space を押すか、 HTTP の入力を開始します。
補完リストから、推奨値のいずれかを選択します：
- HTTP/1.1 の使用を強制する HTTP/1.1
- HTTP/2 の使用を有効にするには HTTP/2 を使用します。
- HTTP/2 (Prior Knowledge) は、HTTP/1.1 にアップグレードせずに HTTP/2 を使用して送信します。サーバーが HTTP/2 接続を処理できることがわかっている場合に使用します。

HTTP クライアント機能の概要を把握するには、構成されたリクエストのいくつかの選択肢である HTTP リクエストコレクションを調べることができます。

HTTP リクエストコレクションからリクエストを開く

リクエストのエディターパネルの上部にあるサンプル例ショートカットリンクをクリックします。
ポップアップメニューで、開きたい HTTP リクエストコレクションを選択します：

cURL リクエストを変換する

cURL(英語) リクエストを使用している場合は、cURL リクエストとエディターでの HTTP リクエスト形式を変換できます。

cURL を HTTP リクエストに変換

cURL リクエストを HTTP リクエストファイルに貼り付けます。 RubyMine はそれを HTTP リクエストフォーマットに変換し、元の cURL リクエストはコメントアウトされたまま残します。
または、HTTP リクエストエディターパネルの上部にあるをクリックして、 cURL を HTTP リクエストに変換を選択します。
cURL を HTTP リクエストに変換ダイアログで、変換する cURL リクエストを入力または貼り付けます。

次の cURL リクエスト例をご覧ください：

                curl 'https://httpbin.org/' -H 'Connection: keep-alive' -H 'Accept: text/html' -H 'Accept-Encoding:
                gzip, deflate' -H 'Accept-Language: en-US,en;q=0.9,es;q=0.8'

RubyMine はそれを次のように変換します：

                # curl 'http://httpbin.org/' -H 'Connection: keep-alive' -H 'Accept: text/html' -H 'Accept-Encoding: gzip, deflate' -H 'Accept-Language: en-US,en;q=0.9,es;q=0.8'
                GET http://httpbin.org/
                Connection: keep-alive
                Accept: text/html
                Accept-Encoding: gzip, deflate
                Accept-Language: en-US,en;q=0.9,es;q=0.8

                ###
            
   

コンバーターは以下の cURL オプションをサポートします：

オプション	説明
-X, --request(英語)	使用するリクエストメソッド。
-H, --header(英語)	リクエストに含めるリクエストヘッダー。
-u, --user(英語) --basic(英語) --digest(英語)	要求とともに提供されるユーザーの資格情報、および使用する許可方法。
-d, --data, --data-ascii(英語) --data-binary(英語) --data-raw(英語) --data-urlencode(英語)	POST リクエストで送信されるデータ。
-F, --form(英語)	POST 要求で送信されるマルチパート / フォームデータメッセージ。
--url(英語)	取得する URL（主に設定ファイルで URL を指定するときに使用されます）。
-i, --include(英語)	HTTP レスポンスヘッダーを出力に含めるかどうかを定義します。
-v, --verbose(英語)	詳細動作モードを有効にします。
-L, --location(英語)	要求されたページが別の場所に移動された場合に要求を再送信することを可能にします。

HTTP リクエストを cURL に変換する

cURL 形式に変換する HTTP リクエストにキャレットを置きます。
Alt+Enter を押して cURL に変換してクリップボードにコピーを選択します。
または、HTTP リクエストエディターパネルの上部にある変換ショートカットリンクをクリックして、キャレットの HTTP リクエストを cURL に変換してコピーするを選択することもできます。

これにより、HTTP リクエストに基づいた cURL リクエストが生成され、クリップボードにコピーされます。

Postman のコレクションと環境をインポートする

Postman コレクションは、関連する HTTP リクエストをグループ化する方法です。 Postman では、コレクションと変数を JSON 形式でエクスポートできます。 HTTP クライアントでファイルを RubyMine にインポートし、それぞれ .http や環境ファイルへ変換できます。

Postman コレクションを HTTP クライアントにインポートする

Postman からコレクションをエクスポートします(英語)。 RubyMine で使用したい場合は、環境ファイルをエクスポートすることもできます。
次のいずれかの方法で RubyMine にファイルをインポートします：
- エクスポートされたファイルがプロジェクト内にある場合は、それを右クリックして Collection を .http ファイルに変換を選択します。
- 任意の .http ファイルを開き、ツールバーのをクリックして、 Postman コレクションを選択します。
- Ctrl+Shift+A を押し、 Import from Postman Collection File の入力を開始し、対応するアクションを選択します。
環境ファイルもインポートする場合は、環境をアタッチを選択してファイルを指定します。 HTTP クライアント環境形式に変換され、指定された .http ファイルに対してこの環境が選択されます。
表示されるウィンドウで、「変換」をクリックします。

応答ハンドラーと事前要求スクリプトを使用する

応答ハンドラースクリプトを使用すると、受信した HTTP レスポンスにプログラムで対応できます。これらのスクリプトを使用すると、受信したデータを自動的に処理し、指定した条件に対して検証することができます。応答ハンドラースクリプトは、HTTP リクエストファイル内の要求の一部として提供され、応答を受信するとすぐに実行されます。応答処理例を表示するには、認証を含むリクエストまたはテストとスクリプトによるリクエストリクエストコレクションを開いてください。

リクエスト前スクリプトを使用すると、 HTTP リクエストで使用される変数を設定できます。

応答ハンドラースクリプトを挿入する

応答ハンドラースクリプトは、その場挿入または外部ファイル参照でリクエストに追加できます。

その場でスクリプトを挿入するには、その前に 戻り値のラップダイアログ を付けて {% %} で囲みます。
GET host/api/test > {% // Response Handler Script ... %}
外部ファイルからスクリプトを挿入するには、 戻り値のラップダイアログ を先頭に追加します。
GET host/api/test > scripts/my-script.js

応答ハンドラースクリプトからの出力 (エラーまたは client.log からの出力) がある場合は、要求の実行時にサービスツールウィンドウのレスポンスハンドラータブに表示されます。

事前リクエストスクリプトを挿入する

リクエスト前スクリプトは、その場でまたは外部ファイル参照でリクエストに追加可能です。

その場でスクリプトを挿入するには、その前に < を付けて {% %} で囲みます。
< {% request.variables.set("petName", "Bella") %} POST https://example.org/pets/{{petName}}
外部ファイルからスクリプトを挿入するには、 < を先頭に追加します。
< scripts/my-script.js POST https://example.org/pets/{{petName}}

リクエスト前スクリプトからの出力 (エラーまたは client.log からの出力) がある場合は、リクエストを実行すると、サービスツールウィンドウのプレリクエストハンドラータブに表示されます。

JavaScript コードをインポートする

場合によっては、変数や関数などの特定の機能を外部ファイルから使用する必要がある場合があります。このため、事前リクエストおよび応答ハンドラースクリプトで、通常の ES6 インポート機能を使用して、ローカル JavaScript ファイルで定義された変数と関数にアクセスできます。

必要な値を JavaScript ファイルからエクスポートします。 HTTP クライアントは、次の形式の export ステートメントをサポートします。
export let name1, name2/*, … */; // also var export const name1 = 1, name2 = 2/*, … */; // also var, let export function functionName() { /* … */ } export { name1, /* …, */ nameN }; export { variable1 as name1, variable2 as name2, /* …, */ nameN }; export default expression; export default function functionName() { /* … */ } export default function () { /* … */ }
必要な値を応答ハンドラーまたは事前要求スクリプトにインポートします。 HTTP クライアントは、次の形式の import ステートメントをサポートします。
import defaultExport from "module-name"; import * as name from "module-name"; import { export1 } from "module-name"; import { export1 as alias1 } from "module-name"; import { export1, export2 } from "module-name"; import { export1, export2 as alias2, /* … */ } from "module-name"; import defaultExport, { export1, /* … */ } from "module-name"; import defaultExport, * as name from "module-name"; import "module-name"; // side effect import
外部ファイルからいくつかのテストを実行したいが何もインポートする必要がない場合は、応答ハンドラースクリプトで副作用インポート（例： import 'test-scripts/mytests' ）を利用できます。これは、共通のテストがあり、複数のリクエストで再利用しながら、一部のリクエストに対して個別のテストを作成 (またはインポート) する機能を維持したい場合に便利です。
import ステートメントを、現在の .http ファイルの先頭にある共通ブロック宣言 ={% ... %} の中に配置することで、そのファイル内のすべてのプリリクエストスクリプトとレスポンスハンドラーから JavaScript モジュールが使用できるようになります。
例 logger.js :
export const logMessage = () => { console.log("Request executed"); };
.http ファイルの例:
={% import { logMessage } from "logger" %} ### < {% logMessage(); %} GET https://examples.http-client.intellij.net/get > {% logMessage(); %}

レスポンスハンドラースクリプトと事前リクエストスクリプトは JavaScript ECMAScript 2023 で記述され、コーディング支援とドキュメントはバンドルされた HTTP 事前要求および応答ハンドラー ライブラリによって処理されます。インプレーススクリプトの場合、この機能は自動的に有効になります。外部スクリプトの場合は、手動で有効にする必要があります。

応答ハンドラーと事前要求スクリプトの JavaScript コーディング支援を有効にする

Ctrl+Shift+A （アクションの検索）を押します。
JavaScript ライブラリの使用と入力し、対応するアクションをクリックし、開いたコンテキストメニューで HTTP 事前要求および応答ハンドラーを選択します。

HTTP Response Handler ライブラリは、レスポンスハンドラースクリプトを作成するために使用される 2 つのオブジェクトを公開します。

client オブジェクトはセッションのメタデータを格納し、スクリプト内で変更可能です。 client の状態はRubyMine終了まで保持されます。 client.global で variable_name として保存した変数は、後続の HTTP リクエストで {{variable_name}} として参照できます。
response は受信したレスポンスに関する情報を保持しています: そのコンテンツタイプ、ステータス、レスポンスボディなど。

エディターで HTTP レスポンスハンドラーライブラリを開くには、ライブラリオブジェクトにキャレットを置き、 Ctrl+B を押します。

応答ハンドラースクリプトにテストを含めることで、HTTP クライアントをテストフレームワークとして利用できます。テストの作成には client.test(testName, function) メソッドを呼び出します。テスト内では、 client.assert(condition, message) メソッドを呼び出し、条件のアサートが可能です：

                GET https://httpbin.org/status/200

                > {%
                    client.test("Request executed successfully", function() {
                        client.assert(response.status === 200, "Response status is not 200");
                    });
                %}
            
   

構造ツールウィンドウを使用して .http ファイル内を移動する

.http ファイルに複数のリクエストがある場合、構造ツールウィンドウは、ファイルをすばやくプレビューしてファイル内を移動できます。ツールウィンドウには、ヘッダー、リクエスト本文、事前リクエストスクリプト、応答ハンドラースクリプトなどのリクエスト部分も表示されます。

構造ツールウィンドウを開きます: 表示 | Tools Windows | 構造。
または、 Alt+7 を押します。
構造ツールウィンドウで、HTTP メソッドまたはリクエスト名、あるいはリクエストの一部をクリックします。

右クリックしてを選択することで、そこからリクエストを送信することもできます。

HTTP リクエストを実行する

単一のリクエストを実行する

独自の Web サービスをテストする場合は、Web サービスがデプロイされ、実行されていることを確認してください。
環境を定義している場合は、リクエストのエディターパネルの上部にある実行リストで環境を選択します。
ガターで、リクエストの横にあるをクリックします。

複数のリクエストを順番に実行する

.http ファイルからのすべてのリクエストを一度に実行できます。これは、サーバーから特定のデータをリクエストし、それを client.global 変数として保存し、そのデータを含む後続のリクエストを送信するなどの複雑なシナリオに役立ちます。

.http ファイルを開きます。
エディターパネルの上部にある (ファイル内のすべてのリクエストを実行) をクリックします。

リクエスト実行時、RubyMineは専用の一時 HTTP リクエスト実行/デバッグ構成を自動作成します。必要に応じて永続的な実行 / デバッグ構成として保存するを使用できます。

ブラウザーでリクエストを開く

設定ダイアログ（Ctrl+Alt+S ）のウェブブラウザーとプレビューページで指定されたブラウザーで HTTP リクエストを開くことができます。

Alt+Enter を押し、 Web ブラウザーで開くインテンションアクションを選択します。

HTTP リクエストの実行 / デバッグ構成を操作する

エディターから HTTP リクエストを実行すると、RubyMine はリクエストパラメーターを使って一時的な実行/デバッグ構成を自動的に作成します。一時的な実行 / デバッグ構成は、永続的な実行 / デバッグ構成と同じように機能します。実行 / デバッグ構成ダイアログを使用して設定を変更し、オプションで永続的に保存できます。

HTTP リクエストの実行 / デバッグ構成を変更する

以下のいずれかを行います：
- エディターでリクエストを右クリックし、コンテキストメニューで実行構成を変更… を選択します。
- または、メインメニューの実行 | 実行構成の編集に移動し、 HTTP リクエストリストから必要な実行 / デバッグ構成を選択します。
必要に応じて構成パラメーターを変更します。
- 環境リストで、リクエストで使用される環境変数のセットを定義する環境を選択します。
- ファイルフィールドに、 HTTP リクエストファイルへのパスを指定します。パスを手動で入力し、入力時にパス補完 Ctrl+Space を使用するか、をクリックして、表示されるダイアログで必要なフォルダーを選択できます。
- 要求ファイルに複数の要求が含まれている場合は、リクエストリストで、実行する要求の名前を選択します。

一時的な HTTP リクエストの実行 / デバッグ構成を保存する

以下のいずれかを行います：

実行 / デバッグ構成セレクターで、 <構成名> を保存を選択します。
実行 / デバッグ構成ダイアログで、構成を選択し、をクリックします。

実行 / デバッグ構成を使用して要求を実行する

以下のいずれかを行います：

実行 / デバッグ構成セレクターで、目的の実行構成を選択します。次に、メインツールバーのをクリックするか、 Shift+F10 を押します。
Alt+Shift+F10 を押し、リストから希望の実行構成を選択して、 Enter を押します。

他の .http ファイルから HTTP リクエストをインポートする

RubyMineは他の .http ファイルから HTTP リクエストのインポートが可能です。次のことが可能です。

指定されたファイルからのすべての HTTP リクエストを実行する
インポートしたファイルから特定の HTTP リクエストを実行する

サンプルをクリックし、 Include を含むリクエストを選択すると、IDE でこの機能の構文例が表示されます。

すべてのリクエストを別の .http ファイルから実行する

.http ファイルで、 実行 に続けて、含める別の .http の名前を入力します。ファイルが同じディレクトリにある場合は、その名前を入力します。そうでない場合は、パスを指定します。例：
run ./myFolder/get-requests.http
このファイルからのすべてのリクエストを送信するには、 実行 の横にあるをクリックします。

別の .http ファイルから特定のリクエストを実行する

.http ファイルの先頭に、 import と入力し、その後に必要なリクエストを含む別の .http の名前を入力します。
実行 と入力し、実行するリクエストの名前を指定します。
Ctrl+Space を押すと、インポートされたファイルで利用可能なすべてのリクエストを表示できます。

インポートされた .http ファイルからの変数を上書きする

インポートされた .http ファイルに変数が含まれている場合は、特定の実行に対してその値を指定または変更できます。

実行 と入力し、 .http ファイルまたはリクエストの名前を指定します。
リクエストまたはファイルの名前の後に、 (@variable=value) 形式で変数を入力します。複数の変数を指定するには、コンマで区切ります。例：
import new-requests.http run #GET request with one var (@host=example.com) run #GET request with two vars (@host=example.com, @user=userName)

Web サービスからの応答を表示する

HTTP リクエスト実行時、RubyMineはレスポンスを .idea/httpRequests/ ディレクトリ配下の別ファイルに自動保存します。最近保存された 50 件の応答を表示し、要求履歴を使用して対応するファイルに移動することができます。リクエストがスクラッチファイルから実行された場合、そのレスポンス出力へのリンクも元のリクエストに追加されます。

受け取った応答を見る

レスポンス受信時に自動的に開くサービスツールウィンドウに切り替えます。
サーバーレスポンスは、リクエストヘッダーの content-type フィールドで指定されたフォーマットでデフォルト表示されます。レスポンスを別のフォーマットに変換したい場合は、をクリックしてテキスト、 JSON、 XML または HTML. を選択します。

レスポンスにバイナリファイルが含まれている場合、このファイルも .idea/httpRequests/ ディレクトリに保存されます。レスポンスがイメージ、PDF、HTML ファイルの場合は、IDE 内で直接プレビューできます。

サービスツールウィンドウでイメージをプレビューします。

サービスツールウィンドウで PDF ファイルをプレビューします。サービスツールウィンドウで PDF プレビューの表示を無効にするには、をクリックして PDF プレビューのインライン化を有効化オプションをクリアします。

応答が HTML ファイルの場合は、プレビューの表示をクリックして、JCEF ベースのブラウザーを使用してエディタータブでプレビューできます。

レスポンスハンドラースクリプトがある場合、このスクリプトの一部として実行されたテストの結果は、サービスツールウィンドウのテストタブに表示されます。各テストをクリックすると、対応するレスポンスハンドラースクリプト内のテストソースコードに簡単に移動できます。

イベントストリームを購読すると、RubyMineはサービスツールウィンドウでイベントを表示します。ここでは、をクリックして、クライアント / サーバー接続のステータスを表示し、接続を終了することもできます。コンテンツタイプ（text/event-stream または application/x-ndjson のいずれか）に応じて、応答はプレーンテキストまたは改行で区切られた JSON としてフォーマットされます。イベントストリームの各行を処理する応答ハンドラースクリプトを作成できます。

ストリームイベントのファイルへのリダイレクトは現在サポートされていません。

エディターで応答ファイルを開く

開きたいレスポンスのリンクにキャレットを合わせます。
次のいずれかを実行してください：
- メインメニューで表示 | ソースに移動へ移動します。
- Ctrl+B または F4 を押します。
- サービスツールウィンドウまたはエディター (スクラッチファイルの場合) で、応答行のリンクを Ctrl+Click します。

JSONPath を使用して JSON レスポンスからデータを抽出する

HTTP クライアントは JSONPath クエリをサポートしており、受信した JSON ドキュメントからデータを解析して抽出することができます。これを行うには、応答ハンドラースクリプトで次の関数を使用します。

jsonPath(ObjectToParse, JSONPathExpression)

この関数をすばやく挿入するには、 jsonPath ライブテンプレートを使用します。

リクエスト後、応答ハンドラースクリプト部分で、 > jsonPath と入力し始めます。
Enter を押してライブテンプレートを展開し、JSONPath 式を補完します。
例: この式は、 slideshow オブジェクトの一部である slides 配列内の最初の要素の タイトル フィールドの値を取得して出力します。
GET https://examples.http-client.intellij.net/json > {% client.log(jsonPath(response.body, "$.slideshow.slides[0].title",)) %}
取得した値をサービスツールウィンドウのレスポンスハンドラータブでプレビューします。

XPath を使用して XML 応答からデータを抽出する

HTTP クライアントは XPath 式をサポートしており、受信した XML ドキュメントからデータを解析・抽出できます。

応答ハンドラースクリプトでは、次の関数を使用します。
xpath(XMLToParse, XPathExpression)
XMLToParse に解析する XML コンテンツ (たとえば、 response.body) を入力し、 XPathExpression に XPath 式を入力します。

例：

            GET https://examples.http-client.intellij.net/xml
            
            > {%
                client.log(xpath(response.body, '//slide[@type="all"][1]/title/text()'))
            %}

スクラッチファイル内のレスポンスを比較する

スクラッチファイルからリクエストを実行した場合、レスポンス出力ファイルへのリンクが元リクエスト直下に追加されます。

以下のいずれかを行います：
- 応答ファイルへのリンクにキャレットを置きます。 Alt+Enter を押して <レスポンス名> と比較インテンションアクションを選択します。
- ガターのをクリックして、リストから <レスポンス名> と比較を選択します。

リクエスト履歴の応答を比較する

物理ファイルからリクエストが実行されると、応答出力へのリンクがリクエストの履歴に追加されます。

応答ファイルへのリンクにキャレットを置きます。メインメニューで表示 | ソースに移動に移動するか、 Ctrl+B または F4 を押して、このファイルを新しいエディタータブで開きます。
メインメニューで表示 | 比較に移動するか、 Ctrl+D を押します。 RubyMineが httpRequests フォルダーからレスポンスファイルを開くよう促します。
現在のファイルと比較する応答ファイルを選択し、オープンをクリックします。

2 つの応答ファイルが差分ビューアーで開かれ、それらの内容を比較できます。

リクエスト履歴を表示

RubyMineは直近 50 件のリクエストを http-requests-log.http ファイルに自動保存し、このファイルはプロジェクト配下の .idea/httpRequests/ ディレクトリにあります。リクエスト履歴により特定のレスポンスへ素早く移動したり、再実行も素早くできます。リクエスト履歴から再実行した場合、その実行情報とレスポンス出力へのリンクが履歴ファイルの先頭に追加されます。

リクエスト履歴を開く

リクエストのエディターパネルの上部にあるをクリックします。
メインメニューからツール | HTTP クライアント | HTTP リクエストの履歴を表示を選択します。

出力をカスタムファイルまたはディレクトリにリダイレクトする

HTTP クライアントは、出力をカスタムファイルまたはディレクトリにリダイレクトできます。強制リダイレクトとソフトリダイレクトの 2 つの演算子をサポートしています。
- >> オペレーターは常に新しいファイルを作成し、要求されたファイル名がすでに存在する場合は、ファイル名に -n 接尾辞を追加します。
- >>! オペレーターは、ファイルがすでに存在する場合、ファイルを書き換えます。

クッキーを管理する

応答によって受信された Cookie は、 .idea/httpRequests/ ディレクトリの専用 http-client.cookies ファイルに自動的に保存されます。保存できるクッキーの数は 300 に制限されています。有効期限に達していない限り、Cookie の名前と値は、Cookie に指定されたドメインとパスに一致する URL への後続の各要求に自動的に含まれます。

クッキーを無期限にしたい場合は、 日付 パラメーターとして -1 を入力します。例：

            # domain path name value date

            .example.com / userId 0x4d2 -1

HTTP リクエストでカスタムクッキーを設定したい場合は、 Cookie ヘッダーを利用できます。クッキーは name=value ペアのリストをセミコロン区切りで入力してください。例：

            GET http://localhost:80/api
            Cookie: theme=dark; country=France

Websocket リクエスト

HTTP クライアントは WebSocket リクエストをサポートします。 HTTP クライアントがリクエストを WebSocket リクエストとして処理するには、 WEBSOCKET キーワードで開始し、その後にサーバーアドレスを続けます。リクエストの構造は次のとおりです。

            WEBSOCKET ws://localhost:8080/websocket
            Content-Type: application/json // Used for content highlighting only

            // Request body, for example:
            {
              "message": "First message sent on connection"
            }
            ===  // message separator
            {
              "message": "Second message" // will be sent right after the previous one
            }
            === wait-for-server  // keyword used to wait for the server response
            {
              "message": "Send this after the server response"
            }
        
  

WebSocket リクエストの作成を高速化するには、次のことができます：

.http ファイルのエディターパネルの上部にあるをクリックし、 WebSocket リクエストを選択します。
.http ファイルで、 wsr と入力し、 Enter を押して WebSocket ライブテンプレートを適用します。

複数のメッセージを送信する

=== セパレーターを使用して、複数のメッセージを送信します。
{ "message": "First message sent on connection" } === // message separator { "message": "Second message" } === { "message": "Third message" }

サーバーの応答後にメッセージを送信する

メッセージの前に、 === wait-for-server と入力します。
これにより、HTTP クライアントはメッセージを送信する前にサーバーの応答を待機します。 === wait-for-server 行を繰り返すことにより、複数の応答を待つことができます。例: 次のメッセージは、3 つのサーバー応答の後に送信されます。
=== wait-for-server === wait-for-server === wait-for-server { "message": "This messages is sent after 3 server responses" }

インタラクティブにメッセージを送信する

接続を開始すると、サービスツールウィンドウから直接サーバーと対話できます。新しいメッセージごとにメッセージを送信したり、サーバーの応答を表示したりできます。

サービスツールウィンドウで、開いている接続を選択します。
ウィンドウの下部の WebSocket に送信されるメッセージに、メッセージの内容を入力します。
その右側で、メッセージ形式（プレーンテキスト、JSON、XML、HTML）を選択します。
Ctrl+Enter を押してリクエストを送信します。

ウィンドウ上部にサーバーレスポンスが表示されます。

GraphQL

RubyMineは HTTP リクエストボディでの GraphQL 操作送信をサポートします。 HTTP または WebSocket を介して送信できます。

GraphQL クエリを使用して HTTP リクエストを作成する

.http ファイルに、 GRAPHQL キーワードに続けてサーバーアドレスを入力します。
リクエストの本文で、GraphQL 操作（クエリ、ミューテーション、サブスクリプション）を作成します。例:
### HTTP request with GraphQL query GRAPHQL http://localhost:8080/graphql query { toDos { title, completed, author { username } } }

GraphQL クエリを使った HTTP リクエストの作成を高速化するには、次のことができます：

.http ファイルのエディターパネルの上部にあるをクリックし、 GraphQL クエリリクエストを選択します。
.http ファイルで、 gqlr と入力し、 Enter を押して GraphQL ライブテンプレートを適用します。

GraphQL 変数を使用する

HTTP リクエストボディでは、クエリ文字列と別に動的データを渡す場合、GraphQL 変数が利用できます。

クエリ部分の後に、JSON 変数辞書を入力します：
query ($name: String!, $capital: String!) { country(name: $name, capital: $capital) { name capital } } { "name": "France", "capital": "Paris" }
HTTP クライアント環境変数も GraphQL 変数値として使えます。例えば、この JSON 内では "{{Author}}" が環境変数です。実行時の値はリクエスト送信時に選択した環境に依存します：
{ "author": "{{Author}}" }

プロキシ設定の構成

設定ダイアログ（Ctrl+Alt+S ）で、外観 & 振る舞いのシステム設定を選択し、次に HTTP プロキシを選択します。
開いた HTTP プロキシダイアログで手動プロキシ構成を選択し、以下を指定します：
- ホスト名およびポート番号フィールドにプロキシのホスト名とポート番号を入力します。
- 認証を有効にするには、プロキシ認証チェックボックスを選択して、対応するフィールドにユーザー名とパスワードを入力します。

クライアント SSL/TLS 証明書を設定する

HTTP サーバーが安全な通信のために SSL/TLS 認証を必要とする場合、HTTPS 要求を送信する前にクライアント証明書を指定する必要がある場合があります。 HTTP クライアントでは、プライベート環境ファイルを使用してクライアント証明書をセットアップできます。

証明書へのパスを指定

.http ファイルの実行リストで、環境を Private ファイルに追加… を選択します。
開いた http-client.private.env.json ファイルで、必要な環境に SSLConfiguration オブジェクトを追加します。 clientCertificate に、クライアント証明書へのパスを入力します。証明書キーが別のファイルに保存されている場合は、そのパスを clientCertificateKey に入力します。例：
{ "dev": { "MyVar": "SomeValue", "SSLConfiguration": { "clientCertificate": "cert.pem", "clientCertificateKey": "MyFolder/key.pem" } } }
絶対パスまたは http-client.private.env.json ファイルへの相対パスを指定できます。環境ファイルがスクラッチに保存されている場合は、プロジェクトルートからの相対パスを追加で指定できます。パスの入力を開始して、コード補完ポップアップを取得します。
また、 clientCertificate および clientCertificateKey をオブジェクトとして記述することで、パスに加えて証明書のフォーマットも指定できます。例：
{ "dev": { "SSLConfiguration": { "clientCertificate": { "path": "file.crt", "format": "PEM" }, "clientCertificateKey": { "path": "file.key", "format": "DER" } } } }

証明書のパスフレーズを設定する

クライアント証明書を生成する際にパスフレーズを使用した場合は、それを HTTP クライアントに指定する必要があります。

http-client.private.env.json ファイルで、 "hasCertificatePassphrase": true を SSLConfiguration オブジェクトに追加します。例:
{ "dev": { "SSLConfiguration": { "clientCertificate": "file.crt", "hasCertificatePassphrase": true } } }
ガターのをクリックするか、キャレットを hasCertificatePassphrase に置いて Alt+Enter を押し、 ''{0}'' の値を設定するを選択します。
開いたウィンドウで証明書パスフレーズを入力します。

パスフレーズを今すぐ入力したくない場合は、2 番目の手順を省略できます。この場合、RubyMine は HTTPS リクエストを実行する際にパスフレーズの入力を求めるプロンプトを表示します。

証明書の検証を無効にする

開発目的で、自己署名証明書または期限切れの証明書を持つホストがある場合があります。このホストを信頼する場合は、その証明書の検証を無効にすることができます。

http-client.private.env.json ファイルで、 verifyHostCertificate": false を SSLConfiguration オブジェクトに追加します。例：
{ "sslTest": { "SSLConfiguration": { "verifyHostCertificate": false } } }

この環境でリクエストを実行すると、RubyMine はホスト証明書を検証しません。

2026 年 6 月 2 日