.NET 6 Swagger添加xml注释

这里我用的是vs2022版本。

1.首先新建一个xml文档在项目根目录。

 

 2.然后选择属性，始终复制(如果不选择的话，发布的程序可能会提示缺少xml文件)。

 

3.打开项目属性，勾选生成api文档，然后选择对应的xml文档路径。

4.添加注释。

 

 

5.最后从Program.cs里面加入如下代码。

 

 

builder.AddSwaggerGen(c =>
    {
        c.SwaggerDoc("v1", new OpenApiInfo
        {
            Title = "这是文档标题",
            Version = "文档版本编号",
            Description = "文档描述"
        });
        var file = Path.Combine(AppContext.BaseDirectory, "XMLFile.xml");  // xml文档绝对路径
        var path = Path.Combine(AppContext.BaseDirectory, file); // xml文档绝对路径
        c.IncludeXmlComments(path, true); // true : 显示控制器层注释
        c.OrderActionsBy(o => o.RelativePath); // 对action的名称进行排序，如果有多个，就可以看见效果了。
    });

　生成项目，启动，就可以看见注释了。