ASP.NET WebApi 中使用swagger 構建在線幫助文檔

1 在Visual Studio 中創建一個Asp.NET  WebApi 項目，項目名：Com.App.SysApi（本例創建的是 .net 4.5 框架程序）

 

2  打開Nuget 包管理軟件，查找 swagger 

安裝Swashbuckle 組件

3 開啟項目的XML注釋位置（選中項目Com.App.SysApi，右鍵屬性）

因為Swagger 是對這些生成的XML注釋文件生成在線文檔，所以要讀取XML文件位置

4 在安裝Swashbuckle 組件后，會自動生成一個SwaggerConfiger  配置文件類

5 打開類文件，刪除默認注釋代碼。加入如下代碼：

 public static void Register()
        {
            var thisAssembly = typeof(SwaggerConfig).Assembly;

            GlobalConfiguration.Configuration.EnableSwagger(c =>
            {
                c.SingleApiVersion("v1", "Com.App.SysApi");
                c.IncludeXmlComments(GetXmlCommentsPath());
               // c.OperationFilter<HttpHeaderFilter>();  // 權限過濾

            }).EnableSwaggerUi(c => {
                c.DocumentTitle("系統開發接口");
                // 使用中文
                c.InjectJavaScript(thisAssembly, "Com.App.SysApi.Scripts.Swagger.swagger_lang.js");
            });
}

其中紅色標代碼，是需要我們手動加的，GetXmlCommentsPath() 這個方法獲取上一步XML文件所在路徑，

添加一個私有方法代碼如下：

 private static string GetXmlCommentsPath()
        {
            return string.Format("{0}/bin/Com.App.SysApi.XML", System.AppDomain.CurrentDomain.BaseDirectory);
        }

注意修改你自己XML注釋文件的位置，到這一步，接口文檔就可以訪問了，

輸入地址：http://localhost:8245/swagger      

或者：http://localhost:8245/swagger/ui/index

訪問接口文件 

6 轉英文為中文：

在Scripts 文件中添加js文件，如下：

粘貼如下代碼到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();

友情提示： 把wagger_lang.js 文件的操作，改成嵌入資源（這一步不改，中文轉換不生效）

然后檢查第5步是否注入js 腳本：下圖紅色代碼

OK ，保存編譯運行。即可看到中文版的在線web API 幫助文檔