Web API接口設(shè)計(jì)經(jīng)驗(yàn)總結(jié)

　　Web API接口設(shè)計(jì)經(jīng)驗(yàn)總結(jié)

　　1、在接口定義中確定MVC的GET或者POST方式

　　由于我們整個(gè)Web API平臺(tái)是基于MVC的基礎(chǔ)上進(jìn)行的API開(kāi)發(fā)，因此整個(gè)Web API的接口，在定義的時(shí)候，一般需要顯示來(lái)聲明接口是［HttpGet］或者［HttpPost］，雖然有些接口也可以不用聲明，但是避免出現(xiàn)類似下面的錯(cuò)誤信息，顯式聲明還是有好處的。

　　請(qǐng)求的資源不支持 http 方法“POST

　　例如在基類定義的查找對(duì)象接口如下所示。

　　/// 《summary》

　　/// 查詢數(shù)據(jù)庫(kù)，檢查是否存在指定ID的對(duì)象

　　/// 《/summary》

　　/// 《param name=“id”》對(duì)象的ID值《/param》

　　/// 《returns》存在則返回指定的對(duì)象，否則返回Null《/returns》

　?。跦ttpGet］

　　public virtual T FindByID（string id， string token）

　　如果是增刪改的接口，一般需要聲明為POST方式提交數(shù)據(jù)，而且基于安全性的考慮，需要攜帶更多的參數(shù)。

　　/// 《summary》

　　/// 插入指定對(duì)象到數(shù)據(jù)庫(kù)中

　　/// 《/summary》

　　/// 《param name=“info”》指定的對(duì)象《/param》

　　/// 《returns》執(zhí)行操作是否成功?！?returns》

　　［HttpPost］

　　public virtual CommonResult Insert（T info， string token， string signature， string timestamp， string nonce， string appid）

　　2、動(dòng)態(tài)對(duì)象的接口定義

　　在一般的Web API接口里面，我們可能都會(huì)碰到很多簡(jiǎn)單類型的參數(shù)，但是又想讓它們以POST方式提交數(shù)據(jù)，那么我們就可以有兩種方法來(lái)處理，一種是定義一個(gè)類來(lái)放置這些參數(shù)，一種是采用動(dòng)態(tài)的JObject參數(shù)，前者有很多不方便的地方，因?yàn)槲覀儾豢赡転槊總€(gè)接口參數(shù)定義多一個(gè)實(shí)體類，這樣可能會(huì)有很多難以管理的類定義。如下面是微信API的調(diào)用接口案例，我們也需要設(shè)置這樣的處理規(guī)則。

　　接口調(diào)用請(qǐng)求說(shuō)明

　　http請(qǐng)求方式： POST（請(qǐng)使用https協(xié)議）

　　https://api.weixin.qq.com/cgi-bin/groups/update？access_token=ACCESS_TOKEN

　　POST數(shù)據(jù)格式：json

　　POST數(shù)據(jù)例子：{“group”：{“id”：108，“name”：“test2_modify2”}}

　　那么我們采用JObject是這么樣的呢，我們來(lái)看接口的定義和處理代碼。JObject是Newtonsoft.Json.Linq命名空間下的一個(gè)對(duì)象。

　　/// 《summary》

　　/// 修改用戶密碼

　　/// 《/summary》

　　/// 《param name=“param”》包含userName和userPassword的復(fù)合對(duì)象《/param》

　　/// 《param name=“token”》用戶訪問(wèn)令牌《/param》

　　/// 《returns》《/returns》

　?。跦ttpPost］

　　public CommonResult ModifyPassword（JObject param， string token）

　　{

　　//令牌檢查，不通過(guò)則拋出異常

　　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（“傳遞參數(shù)出現(xiàn)錯(cuò)誤”）;

　　}

　　}

　　其中我們把JObject對(duì)象轉(zhuǎn)換為我們所需要的對(duì)象的時(shí)候，因?yàn)槲覀儧](méi)有定義具體的實(shí)體類，因此采用了dynamic語(yǔ)法，聲明這是一個(gè)動(dòng)態(tài)對(duì)象，由運(yùn)行時(shí)獲取對(duì)應(yīng)的屬性。

　　dynamic obj = param;

　　這樣我們就可以在調(diào)用的時(shí)候，動(dòng)態(tài)POST對(duì)應(yīng)的JSON對(duì)象給Web API接口，而不需要預(yù)先定義各種接口參數(shù)的類了。

　　/// 《summary》

　　/// 調(diào)用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是根據(jù)token和API的地址等參數(shù)，構(gòu)建一個(gè)完整的提交地址。我們?cè)谏厦娲a通過(guò)

　　var postData = new

　　{

　　userName = userName，

　　userPassword = userPassword

　　}.ToJson（）;

　　就可以動(dòng)態(tài)創(chuàng)建一個(gè)對(duì)象，并生成它的JSON字符串，把數(shù)據(jù)POST提交到對(duì)應(yīng)的API接口里面即可，然后對(duì)結(jié)果進(jìn)行對(duì)象的轉(zhuǎn)換就算完成了。