Swagger文档显示中文注释

参考其他博客总结

1,点击项目【属性】——>【生成】勾选XML文档文件,选择输出路径

取消显示警告添加【;1591】,否则会有警告,不添加也可

 2.修改startup

添加代码,其xmlpath的参数"APIDemo.xml" 为上图所选择的xml文档文件。

var basePath = Path.GetDirectoryName(typeof(Program).Assembly.Location);
//获取应用程序所在目录(绝对,不受工作目录影响,建议采用此方法获取路径)
var xmlPath = Path.Combine(basePath, "APIDemo.xml");
c.IncludeXmlComments(xmlPath,true);//true:显示控制器注释
 c.OrderActionsBy(o => o.RelativePath);

  services.AddSwaggerGen(c =>
            {
                c.SwaggerDoc("v1", new OpenApiInfo { Title = "APIDemo", Version = "v1" });
                var basePath = Path.GetDirectoryName(typeof(Program).Assembly.Location);//获取应用程序所在目录(绝对,不受工作目录影响,建议采用此方法获取路径)
                var xmlPath = Path.Combine(basePath, "APIDemo.xml");
                c.IncludeXmlComments(xmlPath,true);//true:显示控制器注释
                c.OrderActionsBy(o => o.RelativePath);
            });

控制器代码

 效果:

  • 1
    点赞
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值