.NET6 Swagger 显示注释

1、修改Program.cs

这行代码默认就有：

if (app.Environment.IsDevelopment())
{
    app.UseSwagger();
    app.UseSwaggerUI();
}

重点是这里的代码：

builder.Services.AddSwaggerGen((options) => 
{
    options.SwaggerDoc("v1", new OpenApiInfo { Title = "Y核心API", Version = "v1.0", Description = "", });
    var basePath = Path.GetDirectoryName(typeof(Program).Assembly.Location);//获取应用程序所在目录
    var xmlPath = Path.Combine(basePath, $"{Assembly.GetExecutingAssembly().GetName().Name}.xml");//接口action显示注释
    options.IncludeXmlComments(Path.Combine(basePath, "Y.WebAPI.xml"), true);//接口注释
    options.IncludeXmlComments(Path.Combine(basePath, "Y.API.Application.xml"), true);//实体类注释
});

2、修改项目属性

设置生成xml文档

3、运行

这个时候swagger就能看到效果了，注意一点，发布的时候会生成.xml文件，SIT测试环境如果要用swagger也需要把这个xml发布到站点下。