ABP给WebApi添加SwaggerUI,生成可交互接口文档

在ABP模板项目中，通过SwaggerUI可以为我们的WebApi生成动态的可交互接口文档页面，从而可以很方便的测试调用我们的WebApi接口。

一、集成Swagger

右键项目YoYo.Web，打开NuGet程序包管理器，添加Swashbuckle。

其中包含了程序和UI，安装后在App_Start文件夹下生成SwaggerConfig.cs。



完成这一步，Swagger已经集成完毕。

可以访问http://localhost:XXXX/swagger/ui/index。



如果出现异常，可以先尝试取消注释SwaggerConfig.cs中的此行代码

c.ResolveConflictingActions(apiDescriptions => apiDescriptions.First());

二、增强配置

包括从XML接口文档读取，修改规则，汉化

swaggerconfig.cs修改如下：

using System.Web.Http;
using WebActivatorEx;
using YoYo.Web;
using Swashbuckle.Application;
using System.Linq;
using System.IO;

[assembly: PreApplicationStartMethod(typeof(SwaggerConfig), "Register")]

namespace YoYo.Web
{
    public class SwaggerConfig
    {
        public static void Register()
        {
            var thisAssembly = typeof(SwaggerConfig).Assembly;

            GlobalConfiguration.Configuration
                .EnableSwagger(c =>
                    {
                        c.SingleApiVersion("v1", "YoYo");
                        c.IncludeXmlComments(GetXmlCommentsPath("WebApi"));
                        c.IncludeXmlComments(GetXmlCommentsPath("Application"));
                        c.ResolveConflictingActions(apiDescriptions => apiDescriptions.First());
                        c.CustomProvider((defaultProvider) => new CachingSwaggerProvider(defaultProvider));
                    })
                .EnableSwaggerUi(c =>
                    {
                        string resourceName = thisAssembly.FullName.Substring(0, thisAssembly.FullName.IndexOf(",")) + ".Scripts.swaggerui.swagger_lang.js";
                        c.InjectJavaScript(thisAssembly, resourceName);
                    });
        }
        private static string GetXmlCommentsPath(string subName)
        {
            return Directory.GetFiles(System.AppDomain.CurrentDomain.BaseDirectory + "bin\\").FirstOrDefault(n => n.ToLower().EndsWith(subName.ToLower() + ".xml"));
        }
    }
}

在App_Start下新增文件CachingSwaggerProvider.cs

using Microsoft.Ajax.Utilities;
using Swashbuckle.Swagger;
using System;
using System.Collections.Concurrent;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Web;
using System.Xml;

namespace YoYo.Web
{
    public class CachingSwaggerProvider : ISwaggerProvider
    {
        private static ConcurrentDictionary<string, SwaggerDocument> _cache =
            new ConcurrentDictionary<string, SwaggerDocument>();

        private readonly ISwaggerProvider _swaggerProvider;

        public CachingSwaggerProvider(ISwaggerProvider swaggerProvider)
        {
            _swaggerProvider = swaggerProvider;
        }

        public SwaggerDocument GetSwagger(string rootUrl, string apiVersion)
        {
            var cacheKey = string.Format("{0}_{1}", rootUrl, apiVersion);
            SwaggerDocument srcDoc = null;
            //只读取一次
            if (!_cache.TryGetValue(cacheKey, out srcDoc))
            {
                srcDoc = _swaggerProvider.GetSwagger(rootUrl, apiVersion);

                srcDoc.paths.ForEach(n =>
                {
                    SetOperation(n.Value.delete);
                    SetOperation(n.Value.get);
                    SetOperation(n.Value.head);
                    SetOperation(n.Value.options);
                    SetOperation(n.Value.patch);
                    SetOperation(n.Value.post);
                    SetOperation(n.Value.put);
                });

                srcDoc.vendorExtensions = new Dictionary<string, object> { { "ControllerDesc", GetControllerDesc() } };
                _cache.TryAdd(cacheKey, srcDoc);
            }
            return srcDoc;
        }

        private void SetOperation(Operation operation)
        {
            if (operation != null)
            {
                operation.tags[0] = operation.tags[0].Split('_').Last();

                if (operation.parameters == null)
                {
                    operation.parameters = new List<Parameter>();
                }
                operation.parameters.Insert(0, new Parameter()
                {
                    @in = "header",
                    name = "authorization",
                    description = "token",
                    type = "string"
                });
                operation.parameters.Insert(0, new Parameter()
                {
                    @in = "header",
                    name = "X-XSRF-TOKEN",
                    description = "XSRF-TOKEN",
                    type = "string"
                });

                if (operation.operationId.StartsWith("Import"))
                {
                    operation.parameters.Add(new Parameter()
                    {
                        @in = "formData",
                        name = "",
                        type = "file"
                    });
                    if (operation.consumes == null)
                    {
                        operation.consumes = new List<string>();
                    }
                    operation.consumes.Add("multipart/form-data");
                }
            }
        }

        /// <summary>
        /// 从API文档中读取控制器描述
        /// </summary>
        /// <returns>所有控制器描述</returns>
        public static ConcurrentDictionary<string, string> GetControllerDesc()
        {
            ConcurrentDictionary<string, string> controllerDescDict = new ConcurrentDictionary<string, string>();

            GetControllerDescByProject("WebApi", "Controller", controllerDescDict);
            GetControllerDescByProject("Application", "AppService", controllerDescDict);

            return controllerDescDict;
        }

        private static void GetControllerDescByProject(string subName, string endsWith, ConcurrentDictionary<string, string> controllerDescDict)
        {
            string xmlpath = Directory.GetFiles(System.AppDomain.CurrentDomain.BaseDirectory + "bin\\").FirstOrDefault(n => n.ToLower().EndsWith(subName.ToLower() + ".xml"));
            if (File.Exists(xmlpath))
            {
                XmlDocument xmldoc = new XmlDocument();
                xmldoc.Load(xmlpath);
                string type = string.Empty, path = string.Empty, controllerName = string.Empty;

                string[] arrPath;
                int length = -1, cCount = endsWith.Length;
                XmlNode summaryNode = null;
                foreach (XmlNode node in xmldoc.SelectNodes("//member"))
                {
                    type = node.Attributes["name"].Value;
                    if (type.StartsWith("T:"))
                    {
                        //控制器
                        arrPath = type.Split('.');
                        length = arrPath.Length;
                        controllerName = arrPath[length - 1];
                        if (controllerName.EndsWith(endsWith))
                        {
                            //获取控制器注释
                            summaryNode = node.SelectSingleNode("summary");
                            string key = controllerName.StartsWith("I") ?
                                controllerName.Substring(1, 1).ToLower() + controllerName.Substring(2, controllerName.Length - 2 - cCount) :
                                controllerName.Remove(controllerName.Length - cCount, cCount);
                            if (summaryNode != null && !string.IsNullOrEmpty(summaryNode.InnerText) && !controllerDescDict.ContainsKey(key))
                            {
                                controllerDescDict.TryAdd(key, summaryNode.InnerText.Trim());
                            }
                        }
                    }
                }
            }
        }
    }
}

swagger_lang.js，需要将文件属性的“生成操作”设置为“嵌入的资源”，代码如下

///    <summary>
/// 中文转换
///    </summary>
var SwaggerTranslator = (function () {
    //定时执行检测是否转换成中文,最多执行500次  即500*50/1000=25s
    var iexcute = 0,
        //中文语言包
        _words = {
            "Warning: Deprecated": "警告：已过时",
            "Implementation Notes": "实现备注",
            "Response Class": "响应类",
            "Status": "状态",
            "Parameters": "参数",
            "Parameter": "参数",
            "Value": "值",
            "Description": "描述",
            "Parameter Type": "参数类型",
            "Data Type": "数据类型",
            "Response Messages": "响应消息",
            "HTTP Status Code": "HTTP状态码",
            "Reason": "原因",
            "Response Model": "响应模型",
            "Request URL": "请求URL",
            "Response Body": "响应体",
            "Response Code": "响应码",
            "Response Headers": "响应头",
            "Hide Response": "隐藏响应",
            "Headers": "头",
            "Try it out!": "试一下！",
            "Show/Hide": "显示/隐藏",
            "List Operations": "显示操作",
            "Expand Operations": "展开操作",
            "Raw": "原始",
            "can't parse JSON.  Raw result": "无法解析JSON. 原始结果",
            "Model Schema": "模型架构",
            "Model": "模型",
            "apply": "应用",
            "Username": "用户名",
            "Password": "密码",
            "Terms of service": "服务条款",
            "Created by": "创建者",
            "See more at": "查看更多：",
            "Contact the developer": "联系开发者",
            "api version": "api版本",
            "Response Content Type": "响应Content Type",
            "fetching resource": "正在获取资源",
            "fetching resource list": "正在获取资源列表",
            "Explore": "浏览",
            "Show Swagger Petstore Example Apis": "显示 Swagger Petstore 示例 Apis",
            "Can't read from server.  It may not have the appropriate access-control-origin settings.": "无法从服务器读取。可能没有正确设置access-control-origin。",
            "Please specify the protocol for": "请指定协议：",
            "Can't read swagger JSON from": "无法读取swagger JSON于",
            "Finished Loading Resource Information. Rendering Swagger UI": "已加载资源信息。正在渲染Swagger UI",
            "Unable to read api": "无法读取api",
            "from path": "从路径",
            "Click to set as parameter value": "点击设置参数",
            "server returned": "服务器返回"
        },

        //定时执行转换
        _translator2Cn = function () {
            if ($("#resources_container .resource").length > 0) {
                _tryTranslate();
            }

            if ($("#explore").text() === "Explore" && iexcute < 500) {
                iexcute++;
                setTimeout(_translator2Cn, 50);
            }
        },

        //设置控制器注释
        _setControllerSummary = function () {
            $.ajax({
                type: "get",
                async: true,
                url: $("#input_baseUrl").val(),
                dataType: "json",
                success: function (data) {
                    var summaryDict = data.ControllerDesc;
                    var id, controllerName, strSummary;
                    $("#resources_container .resource").each(function (i, item) {
                        id = $(item).attr("id");
                        if (id) {
                            controllerName = id.substring(9);
                            strSummary = summaryDict[controllerName];
                            if (strSummary) {
                                $(item).children(".heading").children(".options").prepend('<li class="controller-summary" title="' + strSummary + '">' + strSummary + '</li>');
                            }
                        }
                    });
                }
            });
        },

        //尝试将英文转换成中文
        _tryTranslate = function () {
            $('[data-sw-translate]').each(function () {
                $(this).html(_getLangDesc($(this).html()));
                $(this).val(_getLangDesc($(this).val()));
                $(this).attr('title', _getLangDesc($(this).attr('title')));
            });
        },
        _getLangDesc = function (word) {
            return _words[$.trim(word)] !== undefined ? _words[$.trim(word)] : word;
        };

    return {
        Translator: function () {
            document.title = "API描述文档";
            $('body').append('<style type="text/css">.controller-summary{color:#10a54a !important;word-break:keep-all;white-space:nowrap;overflow:hidden;text-overflow:ellipsis;max-width:250px;text-align:right;cursor:default;} </style>');
            $("#logo").html("接口描述").attr("href", "/Home/Index");
            //设置控制器描述
            _setControllerSummary();
            _translator2Cn();
        }
    }
})();
//执行转换
SwaggerTranslator.Translator();

function setCookie(c_name, value, expiredays) {
    var exdate = new Date()
    exdate.setDate(exdate.getDate() + expiredays)
    document.cookie = c_name + "=" + escape(value) +
        ((expiredays == null) ? "" : ";expires=" + exdate.toGMTString())
}

function getCookie(c_name) {
    if (document.cookie.length > 0) {
        c_start = document.cookie.indexOf(c_name + "=")
        if (c_start != -1) {
            c_start = c_start + c_name.length + 1
            c_end = document.cookie.indexOf(";", c_start)
            if (c_end == -1) c_end = document.cookie.length
            return unescape(document.cookie.substring(c_start, c_end))
        }
    }
    return ""
}

var token = getCookie("xToken");
if (token) {
    $('[name="authorization"]').val(token);
}

var XSRFToken = getCookie("XSRF-TOKEN");
if (XSRFToken) {
    $('[name="X-XSRF-TOKEN"]').val(XSRFToken);
}

var setToken = function () {
    var json = $("#resource_Account .response_body.json").text()
    if (json) {
        var obj = eval('(' + json + ')');
        if (obj.result) {
            $('[name="authorization"]').val("Bearer " + obj.result);
            setCookie("xToken", "Bearer " + obj.result);
        }
    }
}

setInterval(setToken, 5000)

另外，在Application和WebApi的项目属性，生成输出中，勾选“XML文档文件”，如下图

三、最终效果

代码中还为接口自动添加了X-XSRF-TOKEN和authorization两个参数，可以让我们更方便的调用加了权限的接口。