1、通常我们的webapi项目与domain、dto是在不同的dll中,所以在生成xml时,不仅要把webapi项目的XML文档文件勾选上,还要分别将domain和dto项目的XML文档文件与勾选上。
2、在对应的dto上添加XML文档注释
namespace FM.OCM.Dto.Organize
{
public class OrganizeDto : IDtoVerify
{
/// <summary>
/// ID
/// </summary>
public long Id { get; set; }
/// <summary>
/// 机构代码
/// </summary>
public string OrganizeCode { get; set; }
}
}
3、在SwaggerConfig.cs中加入下面代码,注意在bin目录必须要有生成的xml文档
//设置接口描述xml路径地址
c.IncludeXmlComments(string.Format("{0}/bin/FM.OCM.Web.xml", System.AppDomain.CurrentDomain.BaseDirectory));
// dto对应的描述xml文档路径地址
c.IncludeXmlComments(string.Format("{0}/bin/FM.OCM.Dto.xml", System.AppDomain.CurrentDomain.BaseDirectory));
// domain对应的描述xm文档路径地址
c.IncludeXmlComments(string.Format("{0}/bin/FM.OCM.Domain.xml", System.AppDomain.CurrentDomain.BaseDirectory));
4、生成的swagger文档中就有注释了
5、导入 Yapi中,在Yapi里,就再也不用在Yapi中手工写注释啦。
6、Yapi与swagger的使用https://blog.csdn.net/XinShun/article/details/95339176