码迷,mamicode.com
首页 > 其他好文 > 详细

swagger使用二:swagger配置多个项目注释

时间:2018-04-25 16:59:15      阅读:148      评论:0      收藏:0      [点我收藏+]

标签:.com   ast   复制   tsp   说明   private   nts   nbsp   agg   

转载:https://www.cnblogs.com/eastday/p/6382613.html

 

在项目中采用swagger测试接口,提供接口给其他人员都非常的方便.

在swagger默认配置中,默认只显示接口访问层中的注释,可是很多的参数说明都已经在实体层中了啊?(如下图)不可能再把实体层中的模型再搬过来吧,这样子重复性也太大了.

技术分享图片

经过一番摸索,发现swagger可以同时支持多个路径的.

1.修改swagger的配置,添加多个文件路径.        

    c.IncludeXmlComments(GetXmlControllersCommentsPath());
    c.IncludeXmlComments(GetXmlModelCommentsPath());

 

技术分享图片
        private static string GetXmlControllersCommentsPath()
        {
            return System.IO.Path.Combine(System.Web.HttpRuntime.AppDomainAppPath, "./App_Data/WebApi.XML");
        }
        private static string GetXmlModelCommentsPath()
        {
            return System.IO.Path.Combine(System.Web.HttpRuntime.AppDomainAppPath, "./App_Data/Model.XML");
        }
技术分享图片

2.修改实体层生成时,注释文档保存的位置,注意需要修改到接口访问层中的路径.

技术分享图片

保存,重新生成,再访问swagger。

技术分享图片

可以显示出实体层的注释了,完毕。

 

swagger使用二:swagger配置多个项目注释

标签:.com   ast   复制   tsp   说明   private   nts   nbsp   agg   

原文地址:https://www.cnblogs.com/zhangyang529/p/8945338.html

(0)
(0)
   
举报
评论 一句话评论(0
登录后才能评论!
© 2014 mamicode.com 版权所有  联系我们:gaon5@hotmail.com
迷上了代码!