C# Swagger-ui 生成接口文檔

一、前言

　　相信很多小伙伴對 WebApiTestClient 很熟悉，今天講的是公司目前想更換一個生成接口文檔的插件工具就讓我去了解 Swagger-ui 生成文檔接口，為什么公司用的好好的想換一個而不影響原有的生成接口文檔插件工具呢，原因就是接口多了加載接口文檔超慢的！

　　Swagger-ui 生成文檔接口目前用的是 .Net Framework ，用了之后我覺得這個東西比 WebApiTestClient 還要慢可以說是加載不出來！聽說 .Net Core 版本是可以分組的但是看了一下分組需要准備的東西就覺得目前公司也不是很適用，但是既然學習了如何搭建和使用做個筆錄也不錯！

二、使用nuget加入Swashbuckle的引用

 無需任何修改可直訪問http://localhost:52975/swagger/ui/index

 三、SwaggerConfig簡單介紹

SwaggerConfig.cs文件會自動添加到項目的App_Start目錄下，代碼本身包含大量注釋掉的代碼，清除后，代碼如下：

using System.Web.Http;
using WebActivatorEx;
using Swagger.Admin.Api;
using Swashbuckle.Application;

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

namespace Swagger.Admin.Api
{
    public class SwaggerConfig
    {
        public static void Register()
        {
            var thisAssembly = typeof(SwaggerConfig).Assembly;

            GlobalConfiguration.Configuration
                .EnableSwagger(c =>
                    {
                        c.SingleApiVersion("v1", "Swagger.Admin.Api");
                    })
                .EnableSwaggerUi(c =>
                    {
                    });
        }
    }
}

 相關工程需要生成XML文檔

在 SwaggerConfig.cs 下添加 GetXmlCommentsPath() 方法獲取多個工程文檔路徑（在這里就不做單個演示了基本都差不多）：

/// <summary>
/// 工程生成的xml文檔
/// </summary>
/// <returns></returns>
private static string[] GetXmlCommentsPath()
{
　　  //*是匹配的意思
     return Directory.GetFiles($"{System.AppDomain.CurrentDomain.BaseDirectory}/bin/", "swagger.*.xml");
}

 在 SwaggerConfig.cs 的 Register 方法的 EnableSwagger 匿名函數中加上對應的XML文件，修改如下：

using System.Web.Http;
using WebActivatorEx;
using Swagger.Admin.Api;
using Swashbuckle.Application;
using System.IO;

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

namespace Swagger.Admin.Api
{
    public class SwaggerConfig
    {
        /// <summary>
        /// 工程生成的xml文檔
        /// </summary>
        /// <returns></returns>
        private static string[] GetXmlCommentsPath()
        {
            return Directory.GetFiles($"{System.AppDomain.CurrentDomain.BaseDirectory}/bin/", "swagger.*.xml");
        }
        /// <summary>
        /// 寄存器
        /// </summary>
        public static void Register()
        {
            var thisAssembly = typeof(SwaggerConfig).Assembly;

            GlobalConfiguration.Configuration
                .EnableSwagger(c =>
                    {
                        c.SingleApiVersion("v1", "Swagger.Admin.Api");
                        foreach (var item in GetXmlCommentsPath())
                        {
                            c.IncludeXmlComments(item);
                        }
                    })
                .EnableSwaggerUi(c =>
                    {
                    });
        }
    }
}

 添加一個swagger.Order工程類庫添加OrderController.cs控制器

using System.Web.Http;

namespace swagger.Order
{
    /// <summary>
    /// 訂單
    /// </summary>
    public class OrderController : ApiController
    {
        /// <summary>
        /// 訂單首頁
        /// </summary>
        /// <returns></returns>
        [Route("Index")]
        public string Index()
        {
            return "order";
        }
    }
}

右鍵設置swagger.Order工程類庫

 把 Swagger.Admin.Api 工程下的 ValuesController.cs 控制器修改如下

using System;
using System.Collections.Generic;
using System.Linq;
using System.Net;
using System.Net.Http;
using System.Web.Http;

namespace Swagger.Admin.Api.Controllers
{
    /// <summary>
    /// 默認測試控制器
    /// </summary>
    public class ValuesController : ApiController
    {
        /// <summary>
        /// Get方法
        /// </summary>
        /// <returns></returns>
        public IEnumerable<string> Get()
        {
            return new string[] { "value1", "value2" };
        }


        /// <summary>
        /// 帶參數Get方法
        /// </summary>
        /// <param name="id"></param>
        /// <returns></returns>
        public string Get(int id)
        {
            return "value";
        }

        
        /// <summary>
        /// Post方法
        /// </summary>
        /// <param name="value"></param>
        public void Post([FromBody]string value)
        {
        }

        /// <summary>
        /// Put方法
        /// </summary>
        /// <param name="id"></param>
        /// <param name="value"></param>
        public void Put(int id, [FromBody]string value)
        {
        }

        /// <summary>
        /// Delete方法
        /// </summary>
        /// <param name="id"></param>
        public void Delete(int id)
        {
        }
    }
}

修改好了記得生成一下 swagger.Order 工程項目，然后運行看下是否有文檔描述

為什么控制器的注釋沒有列出來還有我想要漢化版本的怎么處理呢，別急現在就上代碼！

1.在Scripts 下添加 Swagger.js 文件

'use strict';
window.SwaggerTranslator = {
    _words: [],

    translate: function () {
        var $this = this;
        $('[data-sw-translate]').each(function () {
            $(this).html($this._tryTranslate($(this).html()));
            $(this).val($this._tryTranslate($(this).val()));
            $(this).attr('title', $this._tryTranslate($(this).attr('title')));
        });
    },

    setControllerSummary: function () {

        try {
            console.log($("#input_baseUrl").val());
            $.ajax({
                type: "get",
                async: true,
                url: $("#input_baseUrl").val(),
                dataType: "json",
                success: function (data) {

                    var summaryDict = data.ControllerDesc;
                    console.log(summaryDict);
                    var id, controllerName, strSummary;
                    $("#resources_container .resource").each(function (i, item) {
                        id = $(item).attr("id");
                        if (id) {
                            controllerName = id.substring(9);
                            try {
                                strSummary = summaryDict[controllerName];
                                if (strSummary) {
                                    $(item).children(".heading").children(".options").first().prepend('<li class="controller-summary" style="color:green;" title="' + strSummary + '">' + strSummary + '</li>');
                                }
                            } catch (e) {
                                console.log(e);
                            }
                        }
                    });
                }
            });
        } catch (e) {
            console.log(e);
        }
    },
    _tryTranslate: function (word) {
        return this._words[$.trim(word)] !== undefined ? this._words[$.trim(word)] : word;
    },

    learn: function (wordsMap) {
        this._words = wordsMap;
    }
};


/* jshint quotmark: double */
window.SwaggerTranslator.learn({
    "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": "從路徑",
    "server returned": "服務器返回"
});
$(function () {
    window.SwaggerTranslator.translate();
    window.SwaggerTranslator.setControllerSummary();
});

生成操作改為

2.在App_Start文件夾下添加 SwaggerCacheProvider.cs

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 Swagger.Admin.Api
{
    public class SwaggerCacheProvider : ISwaggerProvider
    {
        private readonly ISwaggerProvider _swaggerProvider;
        private static ConcurrentDictionary<string, SwaggerDocument> _cache = new ConcurrentDictionary<string, SwaggerDocument>();
        private readonly string[] _xmls;
        /// <summary>
        /// 
        /// </summary>
        /// <param name="swaggerProvider"></param>
        /// <param name="xmls"></param>
        /// <param name="xml">xml文檔路徑</param>
        public SwaggerCacheProvider(ISwaggerProvider swaggerProvider, params string[] xmls)
        {
            _swaggerProvider = swaggerProvider;
            _xmls = xmls;
        }

        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.vendorExtensions = new Dictionary<string, object> { { "ControllerDesc", GetControllerDesc() } };
                _cache.TryAdd(cacheKey, srcDoc);
            }
            return srcDoc;
        }

        /// <summary>
        /// 從API文檔中讀取控制器描述
        /// </summary>
        /// <returns>所有控制器描述</returns>
        public ConcurrentDictionary<string, string> GetControllerDesc()
        {
            string[] xmlpaths = _xmls;
            ConcurrentDictionary<string, string> controllerDescDict = new ConcurrentDictionary<string, string>();
            foreach (var xmlpath in xmlpaths)
            {
                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 = "Controller".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("Controller"))
                            {
                                //獲取控制器注釋
                                summaryNode = node.SelectSingleNode("summary");
                                string key = controllerName.Remove(controllerName.Length - cCount, cCount);
                                if (summaryNode != null && !string.IsNullOrEmpty(summaryNode.InnerText) && !controllerDescDict.ContainsKey(key))
                                {
                                    controllerDescDict.TryAdd(key, summaryNode.InnerText.Trim());
                                }
                            }
                        }
                    }
                }
            }
            return controllerDescDict;
        }
    }
}

修改 SwaggerConfig.cs 的 Register 方法（我直接把整個cs貼過來算了）

using System.Web.Http;
using WebActivatorEx;
using Swagger.Admin.Api;
using Swashbuckle.Application;
using System.IO;

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

namespace Swagger.Admin.Api
{
    public class SwaggerConfig
    {
        /// <summary>
        /// 工程生成的xml文檔
        /// </summary>
        /// <returns></returns>
        private static string[] GetXmlCommentsPath()
        {
            return Directory.GetFiles($"{System.AppDomain.CurrentDomain.BaseDirectory}/bin/", "swagger.*.xml");
        }
        /// <summary>
        /// 寄存器
        /// </summary>
        public static void Register()
        {
            var thisAssembly = typeof(SwaggerConfig).Assembly;

            GlobalConfiguration.Configuration
                .EnableSwagger(c =>
                    {
                        c.SingleApiVersion("v1", "Swagger.Admin.Api");
                        //處理控制器注釋
                        c.CustomProvider((defaultProvider) => new SwaggerCacheProvider(defaultProvider, GetXmlCommentsPath()));
                        foreach (var item in GetXmlCommentsPath())
                        {
                            c.IncludeXmlComments(item);
                        }
                    })
                .EnableSwaggerUi(c =>
                    {
                        c.InjectJavaScript(System.Reflection.Assembly.GetExecutingAssembly(), "Swagger.Admin.Api.Scripts.Swagger.js");
                    });
        }
    }
}

然后運行一下試試效果

 

 大功告成，簡單的Swagger-ui 的搭建與使用就講到這里了！

當接口多的時候超慢，要加分組功能目前好像是 Swagger2 （.net core）才有整個操作或者是我沒有仔細研究，有辦法解決慢的小伙伴留言交流一下！