產生 TypeSpec 檔案

Dev Proxy 可讓您從攔截的 API 要求和響應產生 TypeSpec 檔案。 使用 Dev Proxy，您可以快速建立現有 API 的 TypeSpec 檔案，並利用支援 TypeSpec 的工具獲得好處。

若要使用 Dev Proxy 產生 TypeSpec 檔案：

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

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

2. 選擇性地在配置檔案中配置外掛程式。

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

3. 在組態檔中，在要監看的URL清單中，新增您要為其產生 TypeSpec 檔案的 API URL：

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

   小提示

   若要建立更好的 TypeSpec 檔案，請考慮使用本地語言模型搭配開發代理。 使用本機語言模型時，TypeSpecGeneratorPlugin 會產生更清楚的作業標識碼和描述，讓您有更好的 TypeSpec 檔案起點。 如需詳細資訊，請參閱 使用本機語言模型。

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

   devproxy
   

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

6. 執行您想要包含在 TypeSpec 檔案中的要求

7. 按下 s 停止錄音請求

8. Dev Proxy 會產生 TypeSpec 檔案，並將它儲存至目前目錄中的檔案。 Dev Proxy 會將檔案命名為 API 主機名，加上當下的日期和時間，例如：api.example.com-20231219091700.tsp。

後續步驟

深入瞭解 TypeSpecGeneratorPlugin。

TypeSpecGenerator外掛程式