ツイートシェアはてブ LINE Pocket

HTTP クライアント

HTTP クライアントプラグインを使用すると、JetBrains Rider コードエディターで HTTP リクエストを直接作成、編集、実行できます。

HTTP リクエストを作成して実行する必要がある場合、主に 2 つのユースケースがあります。

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

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

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

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

必要に応じて、開始する前に、設定 / 環境設定ダイアログ（Ctrl+Alt+S）の HTTP プロキシページでプロキシ設定を構成します。

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

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

スクラッチファイルは、開発中に HTTP リクエストをテストするために使用できます。スクラッチファイルはプロジェクト内に保存されないため、JetBrains Rider はスクラッチファイルを変更し、リクエストに関する追加情報を追加できます。HTTP リクエストがスクラッチファイルから実行されると、応答出力ファイルへのリンクが要求の下と要求履歴ファイルの上部に追加されます。

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

Ctrl+Alt+Shift+Insert を押して HTTP リクエストを選択します。
ソリューションウィンドウでスクラッチビューに切り替え、要求ファイルを追加するフォルダーを右クリックして、コンテキストメニューから追加 | HTTP リクエストを選択します。

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

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

要求ファイルを追加するフォルダーを右クリックし、コンテキストメニューから追加 | HTTP リクエストを選択します。

HTTP リクエストを移動する

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

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

HTTP リクエストを作成する

JetBrains Rider は、エディターでの 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 リクエストに展開されます。

HTTP/2

バージョン 2024.1 以降、JetBrains Rider は 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 リクエストファイルに貼り付けます。JetBrains Rider はそれを 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'
            

JetBrains Rider はそれを以下に変換します:

                # 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 クライアントを使用すると、そのようなファイルを JetBrains Rider にインポートして、それぞれの .http および環境ファイルに変換できます。

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

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

OpenAPI 仕様からリクエストを作成する

OpenAPI 仕様ファイルを使用する場合、指定したエンドポイントへの HTTP リクエストを作成できます。

エンドポイントへの HTTP リクエストを作成する

OpenAPI 仕様ファイルで、エンドポイント定義の横にあるエディターのガターでをクリックします。
または、表示 | ツールウィンドウ | エンドポイントを開き、エンドポイントを右クリックして、HTTP クライアントでリクエストを生成を選択します。

JetBrains Rider は新しい HTTP リクエストを作成し、generated-requests.http スクラッチファイルに保存します。

リクエストをエンドポイントにすぐに送信し、保存したくない場合は、エンドポイントツールウィンドウの HTTP クライアントタブを使用できます。

JetBrains Rider は、利用可能な OpenAPI 仕様に基づいて、リクエスト URL とリクエスト本文 (JSON 形式) の補完を提供します。これはローカルだけでなく、リモート仕様にも適用されます (補完を有効にするには、IDE 設定に追加します )。

エンドポイントとその使用箇所の名前を変更する

名前変更リファクタリングを使用して、定義されたエンドポイントの名前を変更し、HTTP リクエストでの使用を同時に変更します。

以下のいずれかを行います。
- OpenAPI 仕様ファイルで、名前を変更するエンドポイントの定義にキャレットを置きます。
- HTTP リクエストファイルで、名前を変更する URL パスセグメントにキャレットを置きます。
メインメニューまたはコンテキストメニューからリファクタリング | 名前の変更を選択するか、Shift+F6 を押します。
開いた名前変更ダイアログで、新しいエンドポイントの名前を指定します。
プレビューと変更の適用

JetBrains Rider は、エンドポイントとその使用箇所の名前を変更します。

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

応答ハンドラースクリプトを使用すると、受信した 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' など)。これは、共通のテストがあり、複数のリクエストで再利用しながら、一部のリクエストに対して個別のテストを作成 (またはインポート) する機能を維持したい場合に便利です。

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

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

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

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

client オブジェクトはセッションメタデータを格納します。これはスクリプト内で変更できます。client 状態は JetBrains Rider を閉じるまで保持されます。variable_name として client.global に保存されたすべての変数は、{{variable_name}} として後続の HTTP リクエストにアクセス可能です。
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 ファイルに複数のリクエストがある場合、構造ツールウィンドウは、ファイルをすばやくプレビューしてファイル内を移動できます。ツールウィンドウには、ヘッダー、リクエスト本文、事前リクエストスクリプト、応答ハンドラースクリプトなどのリクエスト部分も表示されます。

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

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

HTTP リクエストを実行する

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

.http ファイルで複数の HTTP リクエストが定義されている場合は、それらすべてを順番に実行できます。これを行うには、リクエストのエディターパネルの上部にあるをクリックします。

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

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

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

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

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

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

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

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

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

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

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

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

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

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

受け取った応答を見る

応答が受信されるとすぐに自動的に開くサービスツールウィンドウに切り替えます。
デフォルトでは、サーバーの応答は、content-type(英語) フィールドを介して要求ヘッダーで指定された形式で表示されます。応答を別の形式に変換するには、をクリックして、テキスト、JSON、XML、HTML を選択します。

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

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

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

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

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

The Tests tab of the Services tool window

イベントストリームをサブスクライブすると、JetBrains Rider はサービスツールウィンドウにイベントを表示します。ここでは、をクリックして、クライアント / サーバー接続のステータスを表示し、接続を終了することもできます。コンテンツタイプ（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 配列内の最初の要素の title フィールドの値を取得して出力します。
GET https://examples.http-client.intellij.net/json > {% client.log(jsonPath(response.body, "$.slideshow.slides[0].title",)) %}
取得した値をサービスツールウィンドウのレスポンスハンドラータブでプレビューします。

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

スクラッチファイルから要求が実行されると、応答出力ファイルへのリンクが元の要求に追加されます。

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

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

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

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

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

リクエスト履歴を表示

JetBrains Rider は、最近実行された 50 個の要求を http-requests-log.http ファイルに自動的に保存します。このファイルは、プロジェクトレベルの .idea/httpRequests/ ディレクトリに保管されます。リクエスト履歴を使用すると、特定のレスポンスにすばやく移動したり、リクエストを再度発行したりできます。リクエスト履歴から再度リクエストが発行されると、その実行情報とレスポンス出力へのリンクがリクエスト履歴ファイルの先頭に追加されます。

リクエスト履歴を開く

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

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

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

クッキーを管理する

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

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

            # domain path name value date

            .example.com / userId 0x4d2 -1

HTTP リクエストでカスタム Cookie を設定する場合は、Cookie ヘッダーを使用できます。セミコロンで区切られた name=value ペアのリストとして Cookie を入力します。例:

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

gRPC リクエスト

HTTP クライアントは gRPC リクエストをサポートしています。HTTP クライアントがリクエストを gRPC リクエストとして処理するには、GRPC キーワードでリクエストを開始します。

.proto ファイルに基づいて、JetBrains Rider は gRPC の補完を提供します: すべての既知の gRPC サービス、特定のサーバーの単項およびサーバーストリーミングメソッド、リクエスト本文で受け入れられたメッセージのフィールド。プロジェクトに .proto ファイルがない場合でも、サーバーがアクセス可能なサービスに関する情報を HTTP クライアントに提供する gRPC リフレクション(英語)をサポートしていれば、コード補完を使用できます。

proto ファイルから gRPC リクエストを生成する

proto ファイルで、RPC メソッドの近くにある HTTP クライアントでリクエストを生成をクリックします。

エンドポイントツールウィンドウから gRPC リクエストを生成する

HTTP リクエストと同様に、エンドポイントツールウィンドウを使用して gRPC リクエストを生成することもできます。

エンドポイントツールウィンドウを開きます: 表示 | ツールウィンドウ | エンドポイント。プロジェクトで定義されている場合は、gRPC エンドポイントが表示されます。
エンドポイントを選択します。これにより、HTTP クライアントタブにサンプルリクエストが生成されます。
リクエストを完了し、リクエストの送信をクリックします。デフォルトのアドレスとポートを独自の値に置き換える必要がある場合があります。リクエストボディには、proto ファイルのデータ構造に基づいてコード補完を使用します。
HTTP クライアントタブの下部で応答をプレビューします。

gRPC メタデータを送信する

GRPC リクエストに、次の構文を使用して gRPC メタデータを入力します: Metadata-key: Value
例:
GRPC localhost:8080 X-Myhostname: Example.org

安全な gRPC を使用する

サーバー側 TLS によって保護された接続を開始できます。

アドレスの前に grpcs と入力します。例:
GRPC grpcs://ijhttp-examples.jetbrains.com/hello.HelloService/SayHello

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

JetBrains Rider は、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 を押し、「証明書のパスフレーズ」の値を設定しますを選択します。
開いたウィンドウで、証明書のパスフレーズを入力します。

パスフレーズを今すぐ入力したくない場合は、2 番目の手順を省略できます。この場合、JetBrains Rider は、HTTPS 要求を実行するときにパスフレーズの入力を求めるプロンプトを出します。

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

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

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

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

最終更新日: 2024 年 6 月 17 日