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

最新推荐文章于 2024-04-18 17:32:30 发布

转载最新推荐文章于 2024-04-18 17:32:30 发布 · 957 阅读

0 ·

CC 4.0 BY-SA版权

原文链接：http://www.cnblogs.com/eastday/p/6382613.html

文章标签：

#c# #javascript #python #ViewUI

本文介绍如何在Swagger中配置多路径注释，以便能够显示实体层中的详细注释信息，减少代码冗余并提高接口文档的清晰度。

在项目中采用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");
        }