生成 OpenAPI 规范

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

使用开发代理生成 OpenAPI 规范：

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

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

2. 在配置文件中，要监视的 URL 列表，添加要为其生成 OpenAPI 规范的 API 的 URL：

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

   提示

   若要创建更好的 OpenAPI 规范，请考虑将本地语言模型与开发代理配合使用。 有关详细信息，请参阅 使用本地语言模型。

3. 启动开发代理：

   devproxy
   

4. 通过按键开始录制请求 r

5. 执行要在 OpenAPI 规范中包含的请求

6. 按 s

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