HTTP リクエスト構文の調査

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

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

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

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

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

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

  

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

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

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

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

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

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] }

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

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

  // 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 タグが最初のリクエストに追加されます。

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

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

• リクエストの前に、@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 クライアントはリクエストパラメーターとボディを ASCII 形式にエンコードします。例: リクエストパラメーター内のスラッシュ文字は %2F として送信されます。エンコードを無効にして、リクエストをそのまま送信することもできます。

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

  タグを使用すると、リクエストパラメーターと本文はエンコードされません。

  # @no-auto-encoding GET https://examples.com/api? name=@#$somebody& qwerty=%40%23%24

  結果のリクエストは変更されずに送信されます。

  https://examples.com/api?name=@#$somebody&qwerty=%40%23%24

  タグが使用されていない場合、エンコードはデフォルトで有効になります。

  ### Default behavior GET https://examples.com/api? name=@#$somebody& qwerty=%40%23%24

  このリクエストでは、パラメーターがエンコードされます。

  https://examples.com/api?name=%40%23%24somebody&qwerty=%40%23%24

HTTP リクエストのタイムアウトをカスタマイズする

HTTP クライアントには、サーバーとの接続を確立するための 60 秒のタイムアウトと、進行中の接続で新しいパケットを待機するための別の 60 秒のタイムアウトがあります。これらのタイムアウトは両方ともカスタマイズできます。

• 確立された接続で新しいパケットのタイムアウトを設定するには、リクエストの前に @timeout タグを含むコメント行を追加します。

  # @timeout 600 GET example.com/api

• 接続タイムアウトを設定するには、リクエストの前に @connection-timeout タグを含むコメント行を追加します。

  // @connection-timeout 2 m GET example.com/api

デフォルトでは、タイムアウト値は秒単位ですが、値の後に明示的な時間単位を追加できます。ミリ秒の場合は ms、秒の場合は s、分の場合は m で、たとえば 100 ms または 5 m です。