IntelliJ IDEA 2024.1 ヘルプ

HTTP リクエスト構文の調査

このセクションでは、HTTP リクエストの形式について説明します。HTTP リクエストの送信と HTTP レスポンスの表示の詳細については、「HTTP クライアント」を参照してください。

IntelliJ IDEA コードエディターで HTTP リクエストを作成するには、次の一般的な構文を使用します。

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

HTTP リクエストでコメントを使用する

  • リクエスト内で、// または # で任意の行を開始して、コメント行にします。

    // A basic request GET http://example.com/a/

HTTP リクエストの名前を設定する

実行 / デバッグ構成どこでも検索なんでも実行でリクエストをすばやく見つけるために、名前を付けることができます。

  • リクエストの上にある #### @name# @name = の横に名前を入力します。

Enter the HTTP request name

リクエストに名前がない場合、IntelliJ IDEA は、#1 などのリクエストファイル内の位置をリクエスト名として使用します。リクエストファイルに同じ名前のリクエストが複数含まれている場合、IntelliJ IDEA は各名前にリクエスト位置番号を追加します。これにより、各リクエスト名が一意になり、サービスツールウィンドウ、実行 / デバッグ構成などで必要なリクエスト名を簡単に見つけることができます。

HTTP requests in Services tool window

GET リクエストに短い形式を使用する

  • GET 要求の場合、要求メソッドを省略して URI のみを指定できます。

    // A basic request https://example.com/a/

    Java コンテキストでは、コード補完 Ctrl+Space を使用して、定義された @Path アノテーションに基づいて URI を指定できます。Java コードの @Path アノテーションに対する変更は、候補リストの内容に反映されます。

単一のファイルで複数のリクエストを作成する

  1. リクエストの終わりには、### セパレータをその下に入力します。

    // A basic request https://example.com/a/ ###
  2. セパレータに別のリクエストを作成します。

    // A basic request https://example.com/a/ ### // A second request using the GET method https://example.com:8080/api/html/get?id=123&value=content

長いリクエストをいくつかの行に分割する

  • すべてのクエリ文字列行をインデントしますが、最初の行はインデントします。

    // Using line breaks with indent GET http://example.com:8080 /api /html /get ?id=123 &value=content
  • クエリ文字列が原因で URL が長すぎる場合は、専用のコンテキストアクションを使用して、各クエリパラメーターを新しい行に配置できます。クエリ文字列部分にキャレットを置き、Alt+Enter ( コンテキストアクションの表示 ) を押して、クエリパラメーターを別々の行に配置を選択します。

    GET https://example.com:8080/api/get/html?firstname=John&lastname=Doe&planet=Tatooine&town=Freetown
    GET https://example.com:8080/api/get/html? firstname=John& lastname=Doe& planet=Tatooine& town=Freetown
  • 同様に、Content-Type: application/x-www-form-urlencoded を使用してリクエストの本文をフォーマットできます。キャレットを本文に置き、Alt+Enter ( コンテキストアクションの表示 ) を押して、URL エンコード形式のパラメーターを別々の行に配置を選択します。

    POST https://ijhttp-examples.jetbrains.com/post Content-Type: application/x-www-form-urlencoded key1=value1&key2=value2&key3=value3&key4=value4&key5=value5
    POST https://ijhttp-examples.jetbrains.com/post Content-Type: application/x-www-form-urlencoded key1 = value1 & key2 = value2 & key3 = value3 & key4 = value4 & key5 = value5

    x-www-form-urlencoded ボディのラッピングを構成するには、設定 | エディター | コードスタイル | HTTP リクエスト | 折り返しと波括弧 | フォーム URL でコード化されたパラメーターのラップを使用します。= の前後および & の前にスペースを構成するには、設定 | エディター | コードスタイル | HTTP リクエスト | スペースを使用します。

認証を使用して Web サービスにアクセスする

  • アクセスしている Web サービスに応じて、基本(英語)またはダイジェスト (英語) 許可ヘッダーを提供します。

    // Basic authentication GET http://example.com Authorization: Basic username password ### // Digest authentication GET http://example.com Authorization: Digest username password

要求メッセージ本文を提供する

リクエストの中に空白行を追加し、次のいずれかを実行します。

  • リクエスト本文を適切な場所に入力します。

    // The request body is provided in place POST https://example.com:8080/api/html/post HTTP/1.1 Content-Type: application/json Cookie: key=first-value { "key" : "value", "list": [1, 2, 3] }

    コンテンツタイプヘッダーフィールドの値をサポートされている言語の 1 つに設定すると、対応する言語フラグメントが HTTP リクエストメッセージ本文に自動挿入されます。コンテンツタイプが指定されていない場合は、言語フラグメントを手動で挿入できます。

  • Java コンテキストでは、コード補完 Ctrl+Space を使用して、定義された @Produces アノテーションに基づいて Accept ヘッダーフィールド値を指定できます。Java コードの @Produces アノテーションに対する変更は、候補リストの内容に反映されます。

  • 要求本体をファイルから読み取るには、< シンボルの後にファイルのパスを入力します。

    // The request body is read from a file POST https://example.com:8080/api/html/post Content-Type: application/json < ./input.json

multipart/form-data コンテンツタイプを使用する

  • 要求のコンテンツタイプマルチパート / フォームデータに設定します。マルチパート / フォームデータメッセージの一部としてファイルを送信するには、コンテンツ処理ヘッダーに filename パラメーターを含めます。

    POST https://example.com/api/upload HTTP/1.1 Content-Type: multipart/form-data; boundary=boundary --boundary Content-Disposition: form-data; name="first"; filename="input.txt" // The 'input.txt' file will be uploaded < ./input.txt --boundary Content-Disposition: form-data; name="second"; filename="input-second.txt" // A temporary 'input-second.txt' file with the 'Text' content will be created and uploaded Text --boundary Content-Disposition: form-data; name="third"; // The 'input.txt' file contents will be sent as plain text. < ./input.txt --boundary--

次のリダイレクトを無効にする

HTTP リクエストがリダイレクトされると(3xx ステータスコードが受信されると)、リダイレクトされたページの応答が返されます。サービスツールウィンドウでは、リダイレクトされたページの応答と、要求中に発生したすべてのリダイレクトを表示できます。

次のリダイレクトを無効にすることをお勧めします。この場合、実際のリダイレクト応答ヘッダー(301 または 302 など)が返されます。

  • リクエストの前に、@no-redirect タグ付きのコメント行を追加します。

    // @no-redirect example.com/status/301

リダイレクトされた要求がすでにある場合は、サービスツールウィンドウの Redirections リストの横にある無効にするをクリックできます。これにより、@no-redirect タグが最初のリクエストに追加されます。

HTTP response with redirections

リクエスト履歴へのリクエストの保存を無効にする

必要に応じて、リクエストをリクエスト履歴に保存しないようにすることができます。これは、リクエストに機密データが含まれていて、ログに記録したくない場合に役立ちます。

  • リクエストの前に、@no-log タグ付きのコメント行を追加します。

    // @no-log GET example.com/api

受信した Cookie の Cookie への保存を無効にする jar

必要に応じて、受信した Cookie が Cookie jar に保存されないようにすることができます。このようにして、http-client.cookies ファイルから不要な Cookie を手動で削除することを回避できます。

  • リクエストの前に、@no-cookie-jar タグ付きのコメント行を追加します。

    // @no-cookie-jar GET example.com/api

変数を使用する

HTTP リクエストを作成する場合、変数を使用してその要素をパラメーター化できます。変数は、リクエストのホスト、ポート、パスの値、クエリパラメーターまたは値、ヘッダー値、リクエストの本文内または外部ファイルで使用される任意の値を保持できます。

リクエスト内で変数を使用する

  • 変数を {{variable}} として二重波括弧で囲みます。

変数の名前には、文字、数字、アンダースコア記号 _、ハイフン記号 -、またはドット記号 . を含めることができます。

HTTP クライアントにはいくつかの型の変数があります。

環境変数

環境変数を使用すると、プロジェクト内に一連の環境定義を格納できます。例: リクエストでホスト名を明示的に指定する代わりに、さまざまな環境で {{host}} 変数を作成できます。開発環境ではローカルホスト名、本番環境ではパブリックホスト名です。次に、現在の .http ファイルエディターの上部にある実行リストを使用して、環境を選択できます。

  • 環境がありません : このオプションを選択すると、現在のファイルでリクエストを実行するときに環境は使用されません。リクエストに変数が含まれていない場合は、これを選択します。

  • 環境名(本番環境や開発環境など): 選択した環境は、現在のファイル内のすべてのリクエストに使用されます。The Run button をクリックしたときに環境を選択する必要はありません。これは、同じ環境で複数のリクエストを実行し、リクエストを実行するたびにそれを選択したくない場合に役立ちます。

  • <実行前に環境を選択する> : このオプションを選択すると、The Run button をクリックするたびに環境を選択する必要があります。これは、頻繁に環境を切り替え、実行のたびに環境を明示的に選択して、必要な環境でリクエストを確実に実行したい場合に便利です。「 The Run button 」をクリックします。

Run request: select environment

選択した環境は、リクエストの構造を見るブラウザーでのリクエストのオープン、リクエスト実行、および実行 / デバッグ構成の作成の場合に、デフォルトの環境として使用されます。

環境変数を定義する

環境変数は環境ファイルで定義されます。

  1. リクエストのエディターパネルの上部にある実行リストで、環境を追加する場所を選択します。

    • 環境を公開する場合は、環境を Public ファイルに追加…を選択します。これにより、http-client.env.json ファイルに環境が追加されます。このファイルには、ホスト名、ポート、クエリパラメーターなどの一般的な変数を含めることができ、プロジェクトと一緒に配布することを目的としています。

    • 環境をプライベートにする場合は、環境を Private ファイルに追加…を選択します。これにより、環境が http-client.private.env.json ファイルに追加されます。このファイルには、パスワード、トークン、証明書、その他の機密情報が含まれる場合があります。http-client.private.env.json ファイルで指定された変数の値は、パブリック環境ファイルの値をオーバーライドします。

  2. 作成したファイルに目的の変数を入力します。

    次のサンプル http-client.env.json 環境ファイルは、開発本番の 2 つの環境を定義しています。追加の http-client.private.env.json ファイルは機密認証データを保持します。

    { "development": { "host": "localhost", "id-value": 12345, "username": "", "password": "", "my-var": "my-dev-value" }, "production": { "host": "example.com", "id-value": 6789, "username": "", "password": "", "my-var": "my-prod-value" } }
    { "development": { "username": "dev-user", "password": "dev-password" }, "production": { "username": "user", "password": "password" } }

    HTTP リクエストの例は次のとおりです。

    GET http://{{host}}/api/json/get?id={{id-value}} Authorization: Basic {{username}} {{password}} Content-Type: application/json { "key": "{{my-var}}" }

    IntelliJ IDEA では、リクエストを実行する前に、リクエストのエディターパネルの上部にある実行リストを使用して実行環境を選択できます。

    選択に応じて、結果の要求は次のいずれかになります。

    GET http://localhost/api/json/get?id=12345 Authorization: Basic dev-user dev-password Content-Type: application/json { "key": "my-dev-value" }
    GET http://example.com/api/json/get?id=6789 Authorization: Basic user password Content-Type: application/json { "key": "my-prod-value" }

リクエストの実行時に変数が解決されない場合、IntelliJ IDEA は通知を表示し、別の実行環境をすばやく作成、更新、選択できるようにします。

Unresolved Variable in HTTP request notification

複数の環境ファイルを管理する

プロジェクトには、HTTP リクエストファイルと対応する環境ファイルを含む複数のディレクトリが存在する場合があります。この場合、リクエストの環境を選択する際に次のセクションを使用できます。

  • ファイルに対しては、現在のディレクトリと親ディレクトリに保存されている環境を示します。

    このリストから環境を選択すると、HTTP クライアントは現在のディレクトリに保存されているファイル (パブリックおよびプライベート) 内でその環境を見つけようとします。この環境にファイルがない場合は、親ディレクトリをチェックします。

  • プロジェクト全体からは、プロジェクトの他のすべての場所 (現在のディレクトリと親ディレクトリを除く) に保存されている環境を示します。これらのディレクトリのファイルに、ファイルに対してセクションの環境と同じ名前の環境が含まれている場合、その環境はリストに表示されません。

    プロジェクト内のどこにでも表示されるようにしたい場合は、環境に一意の名前を付けることができます。

HTTP Client environments

これを例で説明してみましょう。次のようなプロジェクト構造があるとします。

root/http-client.env.json # public file with 'dev' environment and 'host' variable root/service1/http-client.private.env.json # private file with 'dev' environment and "key": "myKey1" variable root/service2/http-client.private.env.json # private file with 'dev' environment and "key": "myKey2" variable

service1 ディレクトリに保存されている .http ファイルは、dev 環境を選択すると、key 変数の myKey1 値を使用します。service2 ディレクトリに保存された .http ファイルは、key 変数の myKey2 値を使用します。

プライベートファイルに host 変数が含まれている場合、プライベートファイルはパブリックファイルよりも優先されるため、.http ファイルはその値を使用します。それ以外の場合は、パブリックファイルの値が使用されます。

インプレース変数

インプレース変数のスコープは、それが宣言された .http ファイルです。同じファイル内の複数のリクエストで同じ変数を参照する場合は、インプレース変数を使用します。

インプレース変数を作成するには、HTTP メソッドセクションの上に「@ 」と入力し、その後に変数の名前を入力します。例:

@myhost = example.org GET {{myhost}}/users ### GET {{myhost}}/stats

リクエストごとの変数

request.variables.set(variableName, variableValue) メソッドを使用して、HTTP 要求で使用される変数の値を設定できます。HTTP リクエストの上に、{% ... %} でラップされたプレリクエストスクリプトを記述します。例:

< {% request.variables.set("firstname", "John") %} GET http://example.org/{{firstname}}

プレリクエストスクリプトで定義された変数は、スクリプトに続く単一のリクエスト内でのみ使用できます。

変数の初期化コンテキストアクション (Alt+Enter) を使用すると、インプレース変数または環境変数をすばやく追加したり、リクエスト前ハンドラースクリプトで変数を初期化したりできます。

Initialize variable intention action

プレリクエストスクリプトでは、HTTP クライアント暗号 API を使用して、SHA-1、SHA-256、SHA-512、MD5 などの暗号化ハッシュ関数に基づいて HTTP 署名を生成し、変数としてリクエストに渡すこともできます。例:

< {% const signature = crypto.hmac.sha256() .withTextSecret(request.environment.get("secret")) // get variable from http-client.private.env.json .updateWithText(request.body.tryGetSubstituted()) .digest().toHex(); request.variables.set("signature", signature) const hash = crypto.sha256() .updateWithText(request.body.tryGetSubstituted()) .digest().toHex(); request.variables.set("hash", hash) %} POST https://httpbin.org/post X-My-Signature: {{signature}} X-My-Hash: {{hash}} Content-Type: application/json

動的変数

動的変数は、リクエストを実行するたびに値を生成します。それらの名前は $ で始まります:

  • $uuid または $random.uuid : 普遍的に一意の識別子を生成します (UUID-v4)

  • $timestamp : 現在の UNIX タイムスタンプを生成します

  • $isoTimestamp : UTC タイムゾーンの ISO-8601 形式で現在のタイムスタンプを生成します。

  • $randomInt : 0 〜 1000 のランダムな整数を生成します。

  • $random.integer(from, to) : from (両端を含む) と to (両端を含まない) の間のランダムな整数を生成します (たとえば、random.integer(100, 500))。パラメーターを指定しない場合は、0 ~ 1000 のランダムな整数が生成されます。

  • $random.float(from, to) : from (両端を含む) と to (両端を含まない) の間のランダムな浮動小数点数を生成します (たとえば、random.float(10.5, 20.3))。パラメーターを指定しない場合は、0 ~ 1000 のランダムな浮動小数点数が生成されます。

  • $random.alphabetic(length) : 長さ length (0 より大きい必要があります) の大文字と小文字のシーケンスを生成します。

  • $random.alphanumeric(length) : 長さ length (0 より大きい必要があります) の大文字と小文字、数字、アンダースコアのシーケンスを生成します。

  • $random.hexadecimal(length) : 長さ length (0 より大きい必要があります) のランダムな 16 進文字列を生成します。

  • $random.email : ランダムなメールアドレスを生成します。

  • $exampleServer : は、HTTP クライアントのみを使用してアクセスできる IntelliJ IDEA 組み込み Web サーバーに置き換えられます。この変数は、GraphQL および WebSocket ので使用されます。

URL パラメーターや本文などのリクエスト部分で動的変数を使用します。

POST http://localhost/api/post?id={{$uuid}} { "time": {{$timestamp}}, "price": {{$random.integer(10, 1000)}}, }

これらは、事前リクエストハンドラースクリプトや応答ハンドラースクリプトでも使用できます (JavaScript 変数と同様ですが、波括弧は使用しません)。

< {% const longUUID = $random.uuid request.variables.set("generatedQuery", longUUID) %} GET https://examples.http-client.intellij.net/get ?generatedQuery={{generatedQuery}} > {% client.log(`Today is ${$isoTimestamp}`) %}

応答を処理する

JavaScript を使用して応答を処理できます。リクエストの後に > 文字を入力し、JavaScript ファイルのパスと名前を指定するか、応答ハンドラーのスクリプトコードを {% ... %} でラップします。

GET https://httpbin.org/get > /path/to/responseHandler.js
GET https://httpbin.org/get > {% client.global.set("my_cookie", response.headers.valuesOf("Set-Cookie")[0]); %}

詳細は、HTTP レスポンス処理 API リファレンスを参照してください。

応答をリダイレクトする

応答をファイルにリダイレクトできます。>> を使用して、サフィックスがすでに存在する場合は新しいファイルを作成し、>>! を使用して、ファイルが存在する場合はファイルを書き換えます。絶対パスまたは現在の HTTP リクエストファイルからの相対パスを指定できます。また、環境変数や次の事前定義された変数など、パスで変数を使用することもできます。

  • {{$projectRoot}} はプロジェクトのルートディレクトリを指します

  • {{$historyFolder}}.idea/httpRequests/ を指します

次の HTTP 要求の例では、HTTP 要求ファイルの隣の myFoldermyFile.json を作成し、応答をそれにリダイレクトします。ファイルがすでに存在する場合は、myFile-1.json が作成されます。

POST https://httpbin.org/post Content-Type: application/json { "id": 999, "value": "content" } >> myFolder/myFile.json

次の HTTP リクエストの例では、.idea/httpRequests/myFile.json を作成します。ファイルがすでに存在する場合は、ファイルを上書きします。また、プロジェクトルートにある handler.js スクリプトを使用して応答を処理します。

POST https://httpbin.org/post Content-Type: application/json { "id": 999, "value": "content" } > {{$projectRoot}}/handler.js >>! {{$historyFolder}}/myFile.json

関連ページ:

HTTP クライアント

HTTP クライアントプラグインを使用すると、IntelliJ IDEA コードエディターで HTTP リクエストを直接作成、編集、実行できます。HTTP リクエストを作成して実行する必要がある場合、主に 2 つのユースケースがあります。RESTful Web サービスを開発していて、それが期待どおりに機能し、仕様に準拠してアクセス可能であり、正しく応答することを確認したい場合。RESTful Web サービスに対応するアプリケーションを開発している場合。この場合、開発を開始する前にサービスへの...

どこでも検索

プロジェクト内またはプロジェクト外のアイテムは、その名前で見つけることができます。単一のエントリポイントから、Git 内のファイル、アクション、クラス、シンボル、設定、UI 要素などを検索できます。この機能の使用方法については、次のビデオを参照してください。プロジェクト内のテキストの検索の詳細については、「ファイル内のターゲットを検索」を参照してください。どこでも検索メインメニューで、に移動するか、を 2 回押して検索ウィンドウを開きます。デフォルトでは、IntelliJ IDEA は最近使用...

なんでも実行

なんでも実行は、実行 / デバッグ構成、アプリケーション、スクリプト、コマンド、タスクを起動し、最近のプロジェクトを開くための簡単な方法です。また、入力時に候補を生成することにより、適切なコマンド構文を使用するのにも役立ちます。コマンドを呼び出すと、なんでも実行はそれ以降の作業を適切なツールに委譲します。なんでも実行ポップアップを開く:を 2 回押します。または、ツールバーのをクリックします。アイコンはデフォルトでは非表示になっています。ツールバーにアイコンを追加するには、設定ダイアログ ()...

コード補完

このセクションでは、コーディングプロセスのスピードアップを可能にするコンテキスト対応コード補完のさまざまなテクニックについて説明します。基本補完:基本コード補完は、可視性スコープ内のクラス、メソッド、フィールド、キーワードの名前を完成させるのに役立ちます。コード補完を呼び出すと、IntelliJ IDEA はコンテキストを分析し、現在のキャレット位置から到達可能な選択肢を提案します (提案にはライブテンプレートも含まれます)。基本コード補完がフィールド、パラメーター、変数宣言の一部に適用されて...

IntelliJ IDEA の概要

IntelliJ IDEA は、開発者の生産性を最大化するために設計された Java および Kotlin 用の統合開発環境 (IDE) です。優れたコード補完、静的コード分析、リファクタリングを提供することで、日常的な反復タスクを自動化し、ソフトウェア開発の面白い部分に集中できるようにします。これにより、生産性が向上するだけでなく、楽しい体験も得られます。マルチプラットフォーム:IntelliJ IDEA は、Windows、macOS、Linux で一貫したエクスペリエンスを提供するクロスプ...

言語インジェクション

言語インジェクションを使用すると、コードに埋め込まれた他の言語のコード部分を操作できます。文字列リテラルに言語 (HTML、CSS、XML、RegExp など) を挿入すると、プロジェクトのメイン言語でなくても、挿入されたコードに対して包括的なコーディング支援を受けることができます。一時的に言語をインジェクションするデフォルトでは、IDE は一時的に言語を挿入します。これは、埋め込まれた要素を削除すると、インジェクションも失われることを意味します。言語を挿入する文字列リテラル、タグ、属性内にキャ...