Web API接口設計經驗總結

時間 2019-11-05

原文原文鏈接

在Web API接口的開發過程當中，咱們可能會碰到各類各樣的問題，我在前面兩篇隨筆《Web API應用架構在Winform混合框架中的應用（1）》、《Web API應用架構在Winform混合框架中的應用（2）--自定義異常結果的處理》也進行了總的介紹，在通過個人大量模塊實踐併成功運行後，總結了這篇隨筆，但願對你們有所幫助。html

一、在接口定義中肯定MVC的GET或者POST方式

因爲咱們整個Web API平臺是基於MVC的基礎上進行的API開發，所以整個Web API的接口，在定義的時候，通常須要顯示來聲明接口是[HttpGet]或者[HttpPost]，雖然有些接口也能夠不用聲明，可是避免出現相似下面的錯誤信息，顯式聲明仍是有好處的。數據庫

請求的資源不支持 http 方法「POST

例如在基類定義的查找對象接口以下所示。json

        /// <summary>
        /// 查詢數據庫,檢查是否存在指定ID的對象
        /// </summary>
        /// <param name="id">對象的ID值</param>
        /// <returns>存在則返回指定的對象,不然返回Null</returns>
        [HttpGet]
        public virtual T FindByID(string id, string token)

若是是增刪改的接口，通常須要聲明爲POST方式提交數據，並且基於安全性的考慮，須要攜帶更多的參數。api

        /// <summary>
        /// 插入指定對象到數據庫中
        /// </summary>
        /// <param name="info">指定的對象</param>
        /// <returns>執行操做是否成功。</returns>
        [HttpPost]
        public virtual CommonResult Insert(T info, string token, string signature, string timestamp, string nonce, string appid)

二、動態對象的接口定義

在通常的Web API接口裏面，咱們可能都會碰到不少簡單類型的參數，可是又想讓它們以POST方式提交數據，那麼咱們就能夠有兩種方法來處理，一種是定義一個類來放置這些參數，一種是採用動態的JObject參數，前者有不少不方便的地方，由於咱們不可能爲每一個接口參數定義多一個實體類，這樣可能會有不少難以管理的類定義。以下面是微信API的調用接口案例，咱們也須要設置這樣的處理規則。安全

接口調用請求說明
http請求方式: POST（請使用https協議）
https://api.weixin.qq.com/cgi-bin/groups/update?access_token=ACCESS_TOKEN
POST數據格式：json
POST數據例子：{"group":{"id":108,"name":"test2_modify2"}}

那麼咱們採用JObject是這麼樣的呢，咱們來看接口的定義和處理代碼。JObject是Newtonsoft.Json.Linq命名空間下的一個對象。服務器

        /// <summary>
        /// 修改用戶密碼
        /// </summary>
        /// <param name="param">包含userName和userPassword的複合對象</param>
        /// <param name="token">用戶訪問令牌</param>
        /// <returns></returns>
        [HttpPost]
        public CommonResult ModifyPassword(JObject param,  string token)
        {
            //令牌檢查,不經過則拋出異常
            CheckResult checkResult = CheckToken(token);
            dynamic obj = param; if (obj != null)
            {
                string userName = obj.userName;
                string userPassword = obj.userPassword;

                bool success = BLLFactory<User>.Instance.ModifyPassword(userName, userPassword);
                return new CommonResult(success);
            }
            else
            {
                throw new MyApiException("傳遞參數出現錯誤");
            }
        }

其中咱們把JObject對象轉換爲咱們所須要的對象的時候，由於咱們沒有定義具體的實體類，所以採用了dynamic語法，聲明這是一個動態對象，由運行時獲取對應的屬性。微信

dynamic obj = param;

這樣咱們就能夠在調用的時候，動態POST對應的JSON對象給Web API接口，而不須要預先定義各類接口參數的類了。架構

        /// <summary>
        /// 調用Web API接口，修改用戶密碼
        /// </summary>
        /// <param name="userName">用戶名稱</param>
        /// <param name="userPassword">修改的密碼</param>
        /// <returns>若是修改爲功返回true，不然返回false</returns>
        public bool ModifyPassword(string userName, string userPassword)
        {
            var action = "ModifyPassword";
            var postData = new
            {
                userName = userName,
                userPassword = userPassword
            }.ToJson();

            string url = GetTokenUrl(action);

            CommonResult result = JsonHelper<CommonResult>.ConvertJson(url, postData);
            return (result != null) ? result.Success : false;
        }

其中GetTokenUrl是根據token和API的地址等參數，構建一個完整的提交地址。咱們在上面代碼經過app

            var postData = new
            {
                userName = userName,
                userPassword = userPassword
            }.ToJson();

就能夠動態建立一個對象，並生成它的JSON字符串，把數據POST提交到對應的API接口裏面便可，而後對結果進行對象的轉換就算完成了。框架

三、集合和分頁的處理

在不少接口裏面，咱們都須要用到分頁的處理，Web API也不例外，這樣能夠提交數據檢索效率，減小服務器數據處理的壓力，同時也提交客戶端的數據顯示速度。

通常的集合接口定義以下所示（通用性基類接口）。

        /// <summary>
        /// 返回數據庫全部的對象集合
        /// </summary>
        /// <returns>指定對象的集合</returns>
        [HttpGet]
        public virtual List<T> GetAll(string token)
        {
            //檢查用戶是否有權限，不然拋出MyDenyAccessException異常
            base.CheckAuthorized(AuthorizeKey.ListKey, token);

            List<T> list = baseBLL.GetAll();
            return list;
        }

可是這樣的返回記錄會比較多，通常狀況下須要分頁，那麼分頁的處理接口定義以下所示。

        /// <summary>
        /// 根據條件查詢數據庫,並返回對象集合(用於分頁數據顯示)
        /// </summary>
        /// <returns>指定對象的集合</returns>
        [HttpPost]
        public virtual PagedList<T> FindWithPager(string condition, PagerInfo pagerInfo, string token)

分頁接口，在這裏返回的結果裏面，用了一個PageList的泛型類，這個方便咱們獲取當前的記錄及總數，它的定義以下所示。

    /// <summary>
    /// 分頁集合
    /// </summary>
    /// <typeparam name="T">對象</typeparam>
    public class PagedList<T>
    {
        /// <summary>
        /// 返回記錄的總數
        /// </summary>
        public int total_count { get; set; }

        /// <summary>
        /// 列表集合
        /// </summary>
        public List<T> list { get; set; }
    }

最後整個分頁的處理Web API接口實現以下所示。

        /// <summary>
        /// 根據條件查詢數據庫,並返回對象集合(用於分頁數據顯示)
        /// </summary>
        /// <returns>指定對象的集合</returns>
        [HttpPost]
        public virtual PagedList<T> FindWithPager(string condition, PagerInfo pagerInfo, string token)
        {
            //檢查用戶是否有權限，不然拋出MyDenyAccessException異常
            base.CheckAuthorized(AuthorizeKey.ListKey, token);

            List<T> list = baseBLL.FindWithPager(condition, pagerInfo);

            //構形成Json的格式傳遞
            var result = new PagedList<T>() { total_count = pagerInfo.RecordCount, list = list };
            return result;
        }

最後客戶端調用分頁的Web API代碼以下所示。

        /// <summary>
        /// 根據條件查詢數據庫,並返回對象集合(用於分頁數據顯示)
        /// </summary>
        /// <param name="condition">查詢的條件</param>
        /// <param name="pagerInfo">分頁實體</param>
        /// <returns>指定對象的集合</returns>
        public virtual List<T> FindWithPager(string condition, ref PagerInfo pagerInfo)
        {
            var action = "FindWithPager";
            string url = GetTokenUrl(action) + string.Format("&condition={0}", condition);
            var postData = pagerInfo.ToJson();

            List<T> result = new List<T>();
            PagedList<T> list = JsonHelper<PagedList<T>>.ConvertJson(url, postData);
            if (list != null)
            {
 pagerInfo.RecordCount = list.total_count;//修改總記錄數 result = list.list;
            }
            return result;
        }