参考其他博客总结
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);
});
控制器代码
效果: