產生 TypeSpec 檔案

一目了然
目標： 從截獲的請求建立 TypeSpec
時間： 10分鐘
插件：TypeSpecGeneratorPlugin
前置條件：設定開發代理

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

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

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

   檔案： devproxyrc.json

   {
     "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v2.0.0/rc.schema.json",
     "plugins": [
       {
         "name": "TypeSpecGeneratorPlugin",
         "enabled": true,
         "pluginPath": "~appFolder/plugins/DevProxy.Plugins.dll",
         "configSection": "typeSpecGeneratorPlugin"
       }
     ],
     "urlsToWatch": [
       "https://api.example.com/*"
     ],
     "typeSpecGeneratorPlugin": {
       "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v2.0.0/typespecgeneratorplugin.schema.json",
       "ignoreResponseTypes": false
     }
   }
   

2. 可選擇性地設定該 typeSpecGeneratorPlugin 區段。 設定 ignoreResponseTypes 為 false （預設）讓插件產生回應類型。

3. 在設定檔中，到要監控的 URL 清單中，加入你想產生 TypeSpec 檔案的 API URL。

   小提示

   若要建立更好的 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外掛程式

另請參閱

• 產生 OpenAPI 規範
• 使用當地語言模型
• 記錄與匯出代理活動