產生 OpenAPI 規格

開發代理（Dev Proxy）允許您從攔截的 API 請求和回應中生成 OpenAPI 規範。 使用開發用代理，您可以快速建立現有 API 的 OpenAPI 規格，並利用支援 OpenAPI 的工具。

若要使用 Dev Proxy 產生 OpenAPI 規格：

1. 在設定檔中啟用OpenApiSpecGeneratorPlugin外掛程式。

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

2. 在組態檔中，在要監看的 URL 清單中，新增您要為其產生 OpenAPI 規格的 API URL：

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

   提示

   若要建立更佳的 OpenAPI 規格，請考慮使用本機語言模型與 Dev Proxy。 如需詳細資訊，請參閱 使用本機語言模型。

3. 啟動開發代理伺服器：

   devproxy
   

4. 按下r來開始錄製要求

5. 執行您想要包含在 OpenAPI 規格中的要求

6. 按下 s 停止錄音請求

7. 開發代理伺服器會產生 OpenAPI 規範，並將它儲存至當前目錄中的檔案。 Dev Proxy 會將檔案命名為 API 主機名，加上當下的日期和時間，例如：api.example.com-20231219091700.json。