我们选中我们Application层的项目,右键“属性”,勾选为Xml生成文档,如下图所示。
在你的 项目名.Web.Host 的startup目录下,找到StartUp.cs类,在它的ConfigureServices方法中,找到services.AddSwaggerGen 方法,将生成的Xml配置进去。核心代码如下:
方法1.// Set the comments path for the Swagger JSON and UI.
//路径,路径为XML文档文件路径去玩后的名称
var xmlFile = @"SCBC.SMES.Application.xml";
var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
options.IncludeXmlComments(xmlPath,true);
方法二.// 为 Swagger JSON and UI设置xml文档注释路径
var basePath = Path.GetDirectoryName(typeof(Program).Assembly.Location);//获取应用程序所在目录(绝对,不受工作目录影响,建议采用此方法获取路径)
var xmlPath1 = Path.Combine(basePath, "Myprop.Application.xml");//这个就是应用层配置的xml文件名
options.IncludeXmlComments(xmlPath1, true);
var xmlPath2 = Path.Combine(basePath, "Myprop.Core.xml");//这个就是给领域层配置的xml文件名
options.IncludeXmlComments(xmlPath2, true);