Web API介面設計經驗總結
在Web API介面的開發過程中,我們可能會碰到各種各樣的問題,我在前面兩篇隨筆《Web API應用架構在Winform混合框架中的應用(1)》、《Web API應用架構在Winform混合框架中的應用(2)--自定義異常結果的處理》也進行了總的介紹,在經過我的大量模組實踐併成功執行後,總結了這篇隨筆,希望對大家有所幫助。
1、在介面定義中確定MVC的GET或者POST方式
由於我們整個Web API平臺是基於MVC的基礎上進行的API開發,因此整個Web API的介面,在定義的時候,一般需要顯示來宣告介面是[HttpGet]或者[HttpPost],雖然有些介面也可以不用宣告,但是避免出現類似下面的錯誤資訊,顯式宣告還是有好處的。
請求的資源不支援 http 方法“POST
例如在基類定義的查詢物件介面如下所示。
/// <summary> /// 查詢資料庫,檢查是否存在指定ID的物件 /// </summary> /// <param name="id">物件的ID值</param> /// <returns>存在則返回指定的物件,否則返回Null</returns> [HttpGet] public virtual T FindByID(string id, string token)
如果是增刪改的介面,一般需要宣告為POST方式提交資料,而且基於安全性的考慮,需要攜帶更多的引數。
/// <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)
2、動態物件的介面定義
在一般的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的地址等引數,構建一個完整的提交地址。我們在上面程式碼通過
var postData = new { userName = userName, userPassword = userPassword }.ToJson();
就可以動態建立一個物件,並生成它的JSON字串,把資料POST提交到對應的API接口裡面即可,然後對結果進行物件的轉換就算完成了。
3、集合和分頁的處理
在很多接口裡面,我們都需要用到分頁的處理,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; }
4、混合框架介面整合Web API介面
在整個Web API的平臺構建以及在混合框架的整合過程中,我把各個模組還是遵循相對獨立的方式進行開發和整合,它們實現了從直接訪問資料庫、以WCF服務獲取資料,以及通過WebAPI呼叫方式獲取資料幾種方式的統一,從而實現了整個混合框架的高度整合。
整個混合框架的核心是以相對獨立的方式,整合各個可重用的模組,我們可以遵循一定的基礎上,快速構建統一的應用平臺。
搭建完畢的整個WebAPI平臺,其中包括了服務端內容,以API控制器的方式,釋出了對應的Web API介面。
在每個混合框架的獨立模組裡面,我們封裝了對應的Web API客戶端呼叫處理,從而實現了Web API的呼叫方式。
在Win10下,使用Web API模式執行混合框架,獲得的主體介面效果如下所示。
獨立模組許可權管理系統介面如下所示。
系列文章如下所示:
Web API應用架構在Winform混合框架中的應用(1)
Web API應用架構在Winform混合框架中的應用(2)--自定義異常結果的處理
Web API應用架構在Winform混合框架中的應用(3)--Winfrom介面呼叫WebAPI的過程分解
Web API應用架構在Winform混合框架中的應用(4)--利用程式碼生成工具快速開發整套應用
Web API應用架構在Winform混合框架中的應用(5)--系統級別字典和公司級別字典並存的處理方式
主要研究技術:程式碼生成工具、會員管理系統、客戶關係管理軟體、病人資料管理軟體、Visio二次開發、酒店管理系統、倉庫管理系統等共享軟體開發
專注於Winform開發框架/混合式開發框架、Web開發框架、Bootstrap開發框架、微信門戶開發框架的研究及應用。
轉載請註明出處:
撰寫人:伍華聰 http://www.iqidi.com