HTTP ファイルを生成する

開発プロキシを使用すると、インターセプトされた API 要求と応答から HTTP ファイルを生成できます。 HTTP ファイルの使用は、API の動作をシミュレートしたり、再現可能な API 操作を共有したりする開発者にとって特に便利です。 HTTP ファイルには、関連するすべての要求と応答の詳細が含まれており、機密情報はセキュリティと再利用のために変数に置き換えられます。

開発プロキシを使用して HTTP ファイルを生成するには:

1. 構成ファイルで、 HttpFileGeneratorPluginを有効にします。

   {
     "plugins": [
       {
         "name": "HttpFileGeneratorPlugin",
         "enabled": true,
         "pluginPath": "~appFolder/plugins/DevProxy.Plugins.dll",
         "configSection": "httpFileGeneratorPlugin"
       }
     ]
     // [...] shortened for brevity
   }
   

2. 必要に応じて、プラグインを構成します。

   {
     "httpFileGeneratorPlugin": {
       "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v1.0.0/httpfilegeneratorplugin.schema.json",
       "includeOptionsRequests": false
     }
     // [...] shortened for brevity
   }
   

   • includeOptionsRequests: 生成された HTTP ファイルに OPTIONS 要求を含めるかどうかを決定します。 既定値は false です。

3. 構成ファイルで、監視する URL の一覧に、HTTP ファイルを生成する API の URL を追加します。

   {
     "urlsToWatch": [
       "https://api.example.com/*"
     ]
     // [...] shortened for brevity
   }
   

4. 開発プロキシの起動:

   devproxy
   

5. rキーを押して、要求の記録を開始します。

6. HTTP ファイルに含める API 要求を実行します。

7. sを押して記録を停止します。

8. 開発プロキシは HTTP ファイルを生成し、現在のディレクトリに保存します。 このファイルには、キャプチャされたすべての要求と応答が含まれ、ベアラー トークンや API キーなどの機密データが変数に置き換えられます。 例えば次が挙げられます。

   @jsonplaceholder_typicode_com_api_key = api-key
   ###
   # @name getPosts
   GET https://jsonplaceholder.typicode.com/posts?api-key={{jsonplaceholder_typicode_com_api_key}}
   Host: jsonplaceholder.typicode.com
   User-Agent: curl/8.6.0
   Accept: */*
   Via: 1.1 dev-proxy/0.29.0
   

   プラグインは、ホスト名と機密性の高いパラメーターの組み合わせごとに変数を自動的に作成し、必要に応じて要求間で変数を再利用します。

次のステップ

HttpFileGeneratorPlugin の詳細を確認します。