OpenApiSpecGeneratorPlugin

2025-05-08

从截获的请求和响应生成 JSON 格式的 OpenAPI 规范。

插件实例定义

{
  "name": "OpenApiSpecGeneratorPlugin",
  "enabled": true,
  "pluginPath": "~appFolder/plugins/dev-proxy-plugins.dll",
  "configSection": "openApiSpecGeneratorPlugin"
}

配置示例

{
  "openApiSpecGeneratorPlugin": {
    "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v0.27.0/openapispecgeneratorplugin.schema.json",
    "includeOptionsRequests": false,
    "specVersion": "v3_0",
    "specFormat": "Json"
  }
}

配置属性

properties	说明	默认
`includeOptionsRequests`	确定是否在 `OPTIONS` 生成的 OpenAPI 规范中包含请求	`false`
`specVersion`	确定要用于生成的 OpenAPI 规范的版本。可设置为 `v2_0` 或 `v3_0`	`v3_0`
`specFormat`	确定要用于生成的 OpenAPI 规范的格式。可设置为 `Json` 或 `Yaml`	`Json`

命令行选项

无

注解

若要创建更好的 OpenAPI 规范，请考虑将本地语言模型与开发代理配合使用。使用本地语言模型，生成 OpenApiSpecGeneratorPlugin 更清晰的操作 ID 和说明，从而为 OpenAPI 规范提供更好的起点。若要对 OpenApiSpecGeneratorPlugin本地语言模型使用，请启用配置文件中的语言模型。有关详细信息，请参阅使用本地语言模型。

后续步骤

生成 OpenAPI 规范

通过