生成 TypeSpec 文件

使用开发代理，可以从截获的 API 请求和响应生成 TypeSpec 文件。 使用开发代理，可以快速为现有 API 创建 TypeSpec 文件，并受益于支持 TypeSpec 的工具。

使用开发代理生成 TypeSpec 文件：

1. 在配置文件中，启用 TypeSpecGeneratorPlugin 插件：

   {
     "plugins": [
       {
         "name": "TypeSpecGeneratorPlugin",
         "enabled": true,
         "pluginPath": "~appFolder/plugins/dev-proxy-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 会生成更清晰的操作 ID 和描述，从而为创建 TypeSpec 文件提供一个更好的起点。 有关详细信息，请参阅 使用本地语言模型。

4. 启动开发代理：

   devproxy
   

5. 按 r 开始录制请求

6. 执行要在 TypeSpec 文件中包括的请求

7. 按下 s 停止录制请求

8. 开发代理生成 TypeSpec 文件，并将其保存到当前目录中的文件。 开发代理将文件命名为 API 的主机名后跟当前日期和时间，例如：api.example.com-20231219091700.tsp。

后续步骤

了解更多关于TypeSpecGeneratorPlugin的信息。