Swagger(webapi自動生成接口說明文檔)

時間 2020-07-25

標籤 swagger webapi 自動生成接口說明文檔简体版

原文原文鏈接

1.引入Swashbuckle包

2.添加漢化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();