net下swagger生成接口dto参数的描述信息

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

  • 1
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值