ABP+AdminLTE+Bootstrap Table權限管理系統第五節--WBEAPI及SwaggerUI

返回總目錄:ABP+AdminLTE+Bootstrap Table權限管理系統一期

   一,Web API

              ABP的動態WebApi實現了直接對服務層的調用（其實病沒有跨過ApiController,只是將ApiController公共化，對於這一點的處理相似於MVC，對服務端的 調用沒有跨過HttpHandler同樣），這樣不只減小了ApiController的開發，也更能體現驅動領域設計的層結構。

WEBAPI一樣集成自AbpController, 咱們看到AbpController封裝了不少方法,集成了不少東西,繼承自System.Web.Mvc.Controller,abp包含一下功能

      1,本地化

       2,異常處理

      3,對返回的JsonResult進行包裝

      4,審計日誌

      5,權限認證（[AbpMvcAuthorize]特性）

      6,工做單元（默認未開啓，經過添加[UnitOfWork]開啓）

      7,錯誤機制的響應.

這裏就不細講,會在第五章詳講.可是又多了結果緩存,ABP爲WebAPI請求的響應添加緩存控制header（no-cache,no-store）。所以，它阻止瀏覽器緩存相應，甚至GET請求也會被阻止緩存。能夠在配置裏禁用此功能。

       HTTP特性:通常包含HttpGet、HttepPost,HttpDelete,HttpPut等特性.通常HttpGet、HttepPost,HttpDelete比較經常使用.

      api路由:能夠重定義路由,在外部調用的時候.如 [Route("api/friends/{friendId}")]

        二, SwaggerUI 

 

           前面已經建好服務層的接口了,能夠經過接口直接去請求數據庫.平時咱們請求數據都是在控制器裏面去注入接口,而後調用方法,其實還有一種更好的實現,咱們能夠不經過控制器,直接在頁面js請求的時候直接請求服務接口,ABP集成了Swagger Api.並且這個界面很是的nice.

        swagger-ui 項目地址：https://github.com/swagger-api/swagger-ui

        swagger-ui 官網地址：https://swagger.io/swagger-ui/

添加nuget包

       1,選擇WEBAPI添加nuget包,輸入"Swagger ",會出來智能的出來Swashbuckle和Swagger.Net.UI兩個包,引用其中一個就能夠了,可是不能同時引用,不然生成的時候回會報錯路由錯誤.

       2, 引用到項目中以後,打開WebApiModule.cs,建立ConfigureSwaggerUi方法

       3,而後在重寫的然Initialize()中對他進行調用。

       

     效果

運行項目,依然是WEB爲啓動項目,不須要設置WEBAPI啓動,就看到了如下界面.

 

  

     至此,ABP的WEBAPI基本已經事項,可是仍是存在如下問題.

   1.界面的說明都是英文的須要進行漢化,既然是接口文檔,前端人員在用的時候須要文字說明.

    2.控制器沒有描述

    3.接口過多每次生成速度比較慢

    4,關於調用接口會不會暴露,

    5,移動端調用方式

   6,調用如何確保安全

   7,身份驗證的方式

首先咱們先在application生成xml文檔勾選上

而後修改一下ConfigureSwaggerUi方法

在修改一下DTO註釋驗證,固然咱們已經加上驗證了

運行一下,效果出來了.

修改提示語言爲中文,一個 是注入JavaScript文件，一個是輸入css文件。因此若是這裏能夠對咱們的SwaggerUI界面進行自定義修改的。

  1,須要將js文件路徑注入到SwaggerUI中。

     2,寫入js文件

     

        然而你在運行的發現報錯,其實這裏有兩個套路,自古深情留不起,惟有套路得人心,謹記啊,因此看如下三點:

      3,咱們來看WEBAPI路徑

  

    4,js文件設置嵌入的資源

   

  5,還有一種是在webapimodule中關閉 CSRF功能

 

 或者js裏面寫入如下帶代碼.

     作完以上四步,咱們再來當作果:

  

      以上就是Swagger ui 運用及部分漢化.

其餘

     其餘終端在調用接口是的時候的身份驗證方式,第一種就是cookie認證方式；第二種就是token認證方式：在訪問webapi以前，先要向目標系統申請令牌（token)，申請到令牌後，再使用令牌訪問webapi。Abp默認提供了這種方式；第三種是基於OAuth2.0的token認證方式：OAuth2.0認證方式彌補了Abp自帶token認證的短板，即沒法進行token刷新,這些東西其實我也尚未徹底搞懂,會在後續學習的過程當中加上。

 

///    <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();

  控制器描述和接口文檔緩存

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

        /// <summary>
        /// 從API文檔中讀取控制器描述
        /// </summary>
        /// <returns>全部控制器描述</returns>
        public static ConcurrentDictionary<string, string> GetControllerDesc()
        {
            string xmlpath = string.Format("{0}/bin/SwaggerDemo.XML", System.AppDomain.CurrentDomain.BaseDirectory);
            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 = "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;
        }
    }

 漢化結果:

返回總目錄:ABP+AdminLTE+Bootstrap Table權限管理系統一期