Swagger显示注释

【.net5】

1.【.net5】点击项目，右键=》生成=》勾选XML文档文件=》添加1591取消警告

2.完成之后会生成对应的XML文件

3.在Startup.cs 方法ConfigureServices中修改AddSwaggerGen内容     

   public void ConfigureServices(IServiceCollection services)
        {

            services.AddControllers();
            services.AddTransient<IDeptDao, DeptDao>();
            services.AddTransient<ISystemDao, SystemDao>();
            services.AddTransient<IRoleDao, RoleDao>();
            services.AddSwaggerGen(c =>
            {
                c.SwaggerDoc("v1", new OpenApiInfo { Title = "UserManagerApi接口文档", Version = "v1" });

                var path = Path.Combine(AppContext.BaseDirectory, "UserManagerApi.xml");//Xml文件绝对路径 
                c.IncludeXmlComments(path,true);//显示控制器层注释
                c.OrderActionsBy(s => s.RelativePath);//对Action的名称进行排序
            });
        }

4.运行，完美显示

【.net6】

 1.项目右键属性

 2.生成一下即可得到xml文件，修改文件属性为始终复制

 

 3.在program中编辑如下操作

builder.Services.AddSwaggerGen((options) =>
{
    options.SwaggerDoc("v1", new OpenApiInfo { Title = "Mes.Server.Api接口文档", Version = "v1" });

    var path = Path.Combine(AppContext.BaseDirectory, "MesServerApi.xml");//Xml文件绝对路径 
    options.IncludeXmlComments(path, true);//显示控制器层注释
    options.OrderActionsBy(s => s.RelativePath);//对Action的名称进行排序
     
});

4.运行即可