接口 Swagger 02 顯示代碼注釋

原文：https://www.cnblogs.com/94pm/p/8046580.html
原文：https://www.cnblogs.com/lollipop/p/6651124.html
原文：https://www.cnblogs.com/landeanfen/p/5501487.html

准備工作：https://www.cnblogs.com/guxingy/p/12843876.html

一、Swagger Action 顯示注釋

1、在類HomeApiController.cs中，跟代碼添加注釋，用於測試

2、項目編譯時，生成文檔注釋

操作路徑：項目上右鍵 -> 屬性 -> 生成 -> 勾選XML文檔文件``
XML文檔的默認輸出路徑：bin\WebApplication2.xml

3、讓Swagger讀取XML文檔

在SwaggerConfig.cs這個文件中，取消這句代碼的注釋c.IncludeXmlComments(GetXmlCommentsPath());
在這個類SwaggerConfig.cs中，添加如下方法：（此方法用於返回XML文檔的路徑）

public static string GetXmlCommentsPath()
{
    string path = string.Format("{0}/bin/WebApplication2.xml", System.AppDomain.CurrentDomain.BaseDirectory);
    return path;
}

二、Swagger Controller 顯示注釋

1、添加類SwaggerControllerDescProvider.cs

該類用於顯示控制器的描述，但需要和js配置使用（注意）
代碼如下：

/// <summary>
/// swagger顯示控制器的描述，需要和js配置使用
/// 原文：https://www.cnblogs.com/94pm/p/8046580.html
/// </summary>
public class SwaggerControllerDescProvider : ISwaggerProvider
{
    private readonly ISwaggerProvider _swaggerProvider;
    private static ConcurrentDictionary<string, SwaggerDocument> _cache = new ConcurrentDictionary<string, SwaggerDocument>();
    private readonly string _xml;
    /// <summary>
    /// 
    /// </summary>
    /// <param name="swaggerProvider"></param>
    /// <param name="xml">xml文檔路徑</param>
    public SwaggerControllerDescProvider(ISwaggerProvider swaggerProvider, string xml)
    {
        _swaggerProvider = swaggerProvider;
        _xml = xml;
    }

    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 xmlpath = _xml;
        ConcurrentDictionary<string, string> controllerDescDict = new ConcurrentDictionary<string, string>();
        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 = "ApiController".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;
    }
}

2、修改SwaggerConfig.cs文件

在SwaggerConfig.cs這個文件中，取消代碼注釋，代碼如下
c.CustomProvider((defaultProvider) => new CachingSwaggerProvider(defaultProvider));

將該代碼修改為：
c.CustomProvider((defaultProvider) => new App_Start.SwaggerControllerDescProvider(defaultProvider,GetXmlCommentsPath()));

這個功能需要js配合才行，js的配置在下面

三、Swagger 漢化 和 Controller的注釋顯示（主要是js的配合）

1、添加JS文件

在Scripts文件夾中，添加js文件swagger_lang.js，然后在js文件上，右鍵選擇屬性，生成操作項 選擇 嵌入的資源

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、取消注釋

在WebApiConfig.cs中，取消這句代碼的注釋
c.InjectJavaScript(thisAssembly, "Swashbuckle.Dummy.SwaggerExtensions.testScript1.js");

將這句代碼修改為：
c.InjectJavaScript(thisAssembly, "WebApplication2.Scripts.swagger_lang.js");
注意：這里的js路徑為邏輯路徑。

三、效果展示

注釋包含了幾個部分：參數model的注釋，返回model的注釋等等，仔細一下界面就能發現