You need to enable JavaScript to run this app.
优惠活动
大模型
产品
解决方案
定价
更多

如何配置Swashbuckle.AspNetCore.CLI生成OpenAPI 2.0版本Swagger规范

Swashbuckle CLI 生成OpenAPI 2.0规范配置方法

Swashbuckle CLI 生成文档时不会执行Startup.cs中配置的管道中间件逻辑,因此UseSwagger中设置的SerializeAsV2参数不会生效,可通过以下两种方式配置:

  • 方法一:服务注册阶段全局配置(推荐)
    在Startup.cs的ConfigureServices方法中添加Swagger全局配置,该配置对运行时访问和CLI生成同时生效:
public void ConfigureServices(IServiceCollection services)
{
    // 保留原有AddSwaggerGen相关配置不变
    services.AddSwaggerGen();

    // 新增全局序列化配置
    services.Configure<SwaggerOptions>(options =>
    {
        options.SerializeAsV2 = true;
    });
}

配置完成后直接执行原有swagger tofile命令即可生成OpenAPI 2.0版本规范。

  • 方法二:CLI命令临时指定版本
    无需修改代码,在执行生成命令时添加--serializeasv2参数即可,命令示例:
    swagger tofile --serializeasv2 --output 输出文件名.json 你的项目程序集路径.dll 接口版本号

配置验证:打开生成的JSON规范文件,若头部存在"swagger": "2.0"字段,即为配置生效。

内容的提问来源于stack exchange,提问作者mrwnt10

相关产品推荐
方舟 Agent Plan

超全模态模型 × Harness 升级,最新支持 Deepseek-V4.1-Flash、GLM-5.3 系列、Doubao-Seedream-5.0-pro、Kimi-K3 (部分), 限时 9.9 元起

最近更新时间:2026.10.03 08:45:04