HTTP クライアント

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

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

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

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

HTTP リクエストを移動する

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

1. エディターで、移動するリクエストにキャレットを配置し、次のいずれかを実行します。

   • メインメニューまたはコンテキストメニューから、リファクタリング | 移動を選択します。

   • Alt+Enter を押して、HTTP リクエストの移動 インテンションアクションを選択します。

   • F6 を押します。

2. 開いた HTTP リクエストの移動ダイアログで、次の手順を実行します。

   1. パスフィールドで、リストから既存の .http ファイルの 1 つを選択するか、 をクリックしてファイルを見つけます。

      ファイルへのフルパスを手動で入力することもできます。存在しないファイルの名前を指定すると、指定した名前の新しいファイルが自動的に作成されます。

   2. 要求リストで、移動するリクエストの横にあるチェックボックスをオンにします。

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

Web サービスでカスタム HTTP メソッドを使用する必要がある場合は、そのようなメソッドを WebStorm に追加し、HTTP リクエストで使用することができます。

1. .http ファイルで、カスタムメソッドを大文字で入力します。

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

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

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

1. リクエストのエディターパネルの上部にあるサンプルショートカットリンクをクリックします。

2. ポップアップメニューで、開く HTTP リクエストコレクションを選択します。

   

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

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

1. 構造ツールウィンドウを開きます: 表示 | ツールウィンドウ | 構造。

   または、Alt+7 を押します。

2. 構造ツールウィンドウで、HTTP メソッドまたはリクエスト名、あるいはリクエストの一部をクリックします。

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

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

1. 独自の Web サービスをテストする場合は、Web サービスがデプロイされ、実行されていることを確認してください。

2. 環境を定義している場合は、リクエストのエディターパネルの上部にある実行リストで環境を選択します。

3. ガターで、リクエストの横にある をクリックします。

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

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

1. .http ファイルを開きます。

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

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

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

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

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

1. .http ファイルで、run に続けて、含める別の .http の名前を入力します。ファイルが同じディレクトリにある場合は、その名前を入力します。そうでない場合は、パスを指定します。例:

   run ./myFolder/get-requests.http

2. このファイルからのすべてのリクエストを送信するには、run の横にある をクリックします。

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

1. .http ファイルの先頭に、import と入力し、その後に必要なリクエストを含む別の .http の名前を入力します。

2. run と入力し、実行するリクエストの名前を指定します。

   Ctrl+Space を押すと、インポートされたファイルで利用可能なすべてのリクエストを表示できます。

   

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

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

1. run と入力し、.http ファイルまたはリクエストの名前を指定します。

2. リクエストまたはファイルの名前の後に、(@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)

受け取った応答を見る

1. 応答が受信されるとすぐに自動的に開くサービスツールウィンドウに切り替えます。

2. デフォルトでは、サーバーの応答は、content-type(英語) フィールドを介して要求ヘッダーで指定された形式で表示されます。応答を別の形式に変換するには、 をクリックして、テキスト、JSON、XML、HTML を選択します。

   

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

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

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

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

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

1. 開きたい応答へのリンクにキャレットを置きます。

2. メインメニューで表示 | ソースに移動に移動するか、Ctrl+B または F4 を押します。

あるいは、応答行を Ctrl+Click することもできます。

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

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

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

1. リクエスト後、応答ハンドラースクリプト部分で、> jsonPath と入力し始めます。

2. Enter を押してライブテンプレートを展開し、JSONPath 式を補完します。

   例: この式は、slideshow オブジェクトの一部である slides 配列内の最初の要素の title フィールドの値を取得して出力します。

   GET https://examples.http-client.intellij.net/json > {% client.log(jsonPath(response.body, "$.slideshow.slides[0].title",)) %}

   取得した値をサービスツールウィンドウのレスポンスハンドラータブでプレビューします。

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

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

1. 応答ハンドラースクリプトでは、次の関数を使用します。

   xpath(XMLToParse, XPathExpression)

2. XMLToParse に解析する XML コンテンツ (たとえば、response.body) を入力し、XPathExpression に XPath 式を入力します。

例:

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

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

• 以下のいずれかを行います。

  • 応答ファイルへのリンクにキャレットを置きます。Alt+Enter を押して、<レスポンス名> と比較インテンションの動作を選択します。

  • ガターの をクリックして、リストから <レスポンス名> と比較を選択します。

    

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

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

1. 応答ファイルへのリンクにキャレットを置きます。メインメニューで表示 | ソースに移動に移動するか、Ctrl+B または F4 を押して、このファイルを新しいエディタータブで開きます。

2. メインメニューで表示 | 比較に移動するか、Ctrl+D を押します。WebStorm は、httpRequests フォルダーから応答ファイルを開くように求めるプロンプトを表示します。

3. 現在のファイルと比較する応答ファイルを選択し、オープンをクリックします。

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

リクエスト履歴を開く

• リクエストのエディターパネルの上部にある をクリックします。

• メインメニューからツール | HTTP クライアント | HTTP リクエストの履歴を表示を選択します。

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

• HTTP クライアントは、出力をカスタムファイルまたはディレクトリにリダイレクトできます。強制リダイレクトとソフトリダイレクトの 2 つの演算子をサポートしています。

  • >> オペレーターは常に新しいファイルを作成し、要求されたファイル名がすでに存在する場合は、ファイル名に -n 接尾辞を追加します。

  • >>! オペレーターは、ファイルがすでに存在する場合、ファイルを書き換えます。

始める前に

• JetBrains マーケットプレイスからプラグインをインストールする説明に従って、設定 | プラグインページのマーケットプレースタブにプロトコルバッファおよび gRPC プラグインをインストールします。

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

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

  

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

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

1. エンドポイントツールウィンドウを開きます: 表示 | ツールウィンドウ | エンドポイント。プロジェクトで定義されている場合は、gRPC エンドポイントが表示されます。

2. エンドポイントを選択します。これにより、HTTP クライアントタブにサンプルリクエストが生成されます。

3. リクエストを完了し、リクエストの送信をクリックします。デフォルトのアドレスとポートを独自の値に置き換える必要がある場合があります。リクエストボディには、proto ファイルのデータ構造に基づいてコード補完を使用します。

4. 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

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

• === セパレーターを使用して、複数のメッセージを送信します。

  { "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" }

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

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

1. サービスツールウィンドウで、開いている接続を選択します。

2. ウィンドウの下部の WebSocket に送信されるメッセージに、メッセージの内容を入力します。

3. その右側で、メッセージ形式（プレーンテキスト、JSON、XML、HTML）を選択します。

4. Ctrl+Enter を押してリクエストを送信します。

ウィンドウの上部に、サーバーの応答が表示されます。

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

1. .http ファイルに、GRAPHQL キーワードに続けてサーバーアドレスを入力します。

2. リクエストの本文で、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}}" }

1. 設定ダイアログ（Ctrl+Alt+S）で、外観 & 振る舞いのシステム設定を選択し、次に HTTP プロキシを選択します。

2. 開いた HTTP プロキシダイアログで、手動プロキシ構成を選択し、以下を指定します。

   • ホスト名およびポート番号フィールドにプロキシのホスト名とポート番号を入力します。

   • 認証を有効にするには、プロキシ認証チェックボックスを選択して、対応するフィールドにユーザー名とパスワードを入力します。

証明書へのパスを指定

1. .http ファイルの実行リストで、環境を Private ファイルに追加を選択します。

2. 開いた http-client.private.env.json ファイルで、必要な環境に SSLConfiguration オブジェクトを追加します。clientCertificate に、クライアント証明書へのパスを入力します。証明書キーが別のファイルに保存されている場合は、そのパスを clientCertificateKey に入力します。例:

   { "dev": { "MyVar": "SomeValue", "SSLConfiguration": { "clientCertificate": "cert.pem", "clientCertificateKey": "MyFolder/key.pem" } } }

   または、clientCertificate と clientCertificateKey をオブジェクトとして記述することもできます。これにより、パスに加えて証明書の形式を指定できます。例:

   { "dev": { "SSLConfiguration": { "clientCertificate": { "path": "file.crt", "format": "PEM" }, "clientCertificateKey": { "path": "file.key", "format": "DER" } } } }

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

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

1. http-client.private.env.json ファイルで、"hasCertificatePassphrase": true を SSLConfiguration オブジェクトに追加します。例:

   { "dev": { "SSLConfiguration": { "clientCertificate": "file.crt", "hasCertificatePassphrase": true } } }

2. ガターの をクリックするか、キャレットを hasCertificatePassphrase に置いて Alt+Enter を押し、「証明書のパスフレーズ」の値を設定しますを選択します。

3. 開いたウィンドウで、証明書のパスフレーズを入力します。

   

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

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

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

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

  { "sslTest": { "SSLConfiguration": { "verifyHostCertificate": false } } }

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