PhpStormコードエディターのHTTPクライアント

• cURLリクエストを .http ファイルに貼り付けると、その場で変換されます。

• あるいは、メインメニューからツール | HTTP クライアント | cURL を HTTP リクエストに変換するを選択します。開いたダイアログで、cURLリクエストを入力します。

  

  変換をクリックすると、変換されたリクエストを含む新しいスクラッチファイルが作成されてエディターに表示されます。

環境変数を定義する

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

1. プロジェクト内で、次のファイルを作成します。

   • rest-client.env.json （または http-client.env.json）は、共通の変数を含む通常のファイルであり、プロジェクトとともに配布されることを意図しています。

   • rest-client.private.env.json （または http-client.private.env.json）は、パスワード、トークン、証明書、およびその他の機密情報を含む可能性のあるプライベートファイルです。このファイルは、デフォルトでVCS無視ファイルのリストに追加されます。 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}}&key={{unresolved_var}} Authorization: Basic {{username}} {{password}} Content-Type: application/json { "key": {{my-var}} }

   上記の要求を実行すると、PhpStormは定義された実行環境の中から選択を提供します。

   

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

   GET http://localhost/api/json/get?id=12345&key={{unresolved_var}} Authorization: Basic dev-user dev-password Content-Type: application/json { "key": "my-dev-value" }

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

   {{unresolved-var}} 変数は環境ファイルで定義されていないため、PhpStormはどちらの場合も要求の一部として {{unresolved-var}} テキストを送信します。

スクリプトをリクエストに挿入する

• その場でスクリプトを挿入するには、その前に > を付けて {% %}で囲みます。

  GET host/api/test > {% // Response Handler Script ... %}

• 外部ファイルからスクリプトを挿入するには、>を先頭に追加します。

  GET host/api/test > scripts/my-script.js

JavaScriptファイルでHTTP レスポンス・ハンドラーのコーディング支援を有効にする

1. スクリプトファイルをエディターで開きます。

2. コンテキストメニューでJavaScript ライブラリーの使用 | HTTP レスポンス・ハンドラーを選択します。

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

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

   • エディターで、実行/デバッグ構成を作成したい要求のコンテキストメニューから<設定名>を作成するを選択します。

     

   • または、メインメニューから実行 | 構成の編集を選択してから をクリックし、リストからHTTP 要求を選択します。

     

2. 実行/デバッグ構成パラメーターを指定します。

   • 環境リストで、要求で使用される環境変数のセットを定義する環境を選択します。

   • ファイルフィールドに、HTTPリクエストファイルへのパスを指定します。パスを手動で入力し、入力時にパス補完 Ctrl+Space を使用するか、 をクリックして、表示されるダイアログで必要なフォルダーを選択できます。

   • リクエストファイルに複数のリクエストが含まれている場合は、リクエストリストで実行するリクエストのインデックスを選択します。

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

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