WebAPI接口设计经验总结

1、Web API接口设计经验总结在Web API接口的开发过程中，我们可能会碰到各种各样的问题，我在前面两篇随笔Web API应用架构在Winform混合框架中的应用（1）、Web API应用架构在Winform混合框架中的应用（2）-自定义异常结果的处理也进行了总的介绍，在经过我的大量模块实践并成功运行后，总结了这篇随笔，希望对大家有所帮助。1、在接口定义中确定MVC的GET或者POST方式由于我们整个Web API平台是基于MVC的基础上进行的API开发，因此整个Web API的接口，在定义的时候，一般需要显示来声明接口是HttpGet或者HttpPost，虽然有些接口也可以不用声明，但是避

2、免出现类似下面 的错误信息，显式声明还是有好处的。例如在基类定义的查找对象接口如下所示。1. /2. /查询数据库,检查是否存在指定ID的对象3. /4. /对象的ID值5. /存在则返回指定的对象,否则返回Null6. HttpGet7. publicvirtualTFindByID(stringid,stringtoken)如果是增删改的接口，一般需要声明为POST方式提交数据，而且基于安全性的考虑，需要携带更多的参数。1. /2. /插入指定对象到数据库中3. /4. /指定的对象5. /执行操作是否成功。6. HttpPost7. publicvirtualCommonResultIn

3、sert(Tinfo,stringtoken,stringsignature,stringtimestamp,stringnonce,stringappid)2、动态对象的接口定义在一般的Web API接口里面，我们可能都会碰到很多简单类型的参数，但是又想让它们以POST方式提交数据，那么我们就可以有两种方法来处理，一种是定义一个类来放置 这些参数，一种是采用动态的JObject参数，前者有很多不方便的地方，因为我们不可能为每个接口参数定义多一个实体类，这样可能会有很多难以管理的类 定义。如下面是微信API的调用接口案例，我们也需要设置这样的处理规则。1. 接口调用请求说明2. http请求方

4、式:POST（请使用https协议）3. 4. POST数据格式：json5. POST数据例子：group:id:108,name:test2_modify2那么我们采用JObject是这么样的呢，我们来看接口的定义和处理代码。JObject是Newtonsoft.Json.Linq命名空间下的一个对象。1. /2. /修改用户密码3. /4. /包含userName和userPassword的复合对象5. /用户访问令牌6. /7. HttpPost8. publicCommonResultModifyPassword(JObjectparam,stringtoken)9. 10. /令牌

5、检查,不通过则抛出异常11. CheckResultcheckResult=CheckToken(token);12. dynamicobj=param;13. if(obj!=null)14. 15. stringuserName=obj.userName;16. stringuserPassword=obj.userPassword;17. 18. boolsuccess=BLLFactory.Instance.ModifyPassword(userName,userPassword);19. returnnewCommonResult(success);20. 21. else22. 2

6、3. thrownewMyApiException(传递参数出现错误);24. 25. 其中我们把JObject对象转换为我们所需要的对象的时候，因为我们没有定义具体的实体类，因此采用了dynamic语法，声明这是一个动态对象，由运行时获取对应的属性。dynamic obj = param;这样我们就可以在调用的时候，动态POST对应的JSON对象给Web API接口，而不需要预先定义各种接口参数的类了。1. /2. /调用WebAPI接口，修改用户密码3. /4. /用户名称5. /修改的密码6. /如果修改成功返回true，否则返回false7. publicboolModifyPassw

7、ord(stringuserName,stringuserPassword)8. 9. varaction=ModifyPassword;10. varpostData=new11. 12. userName=userName,13. userPassword=userPassword14. .ToJson();15. 16. stringurl=GetTokenUrl(action);17. 18. CommonResultresult=JsonHelper.ConvertJson(url,postData);19. return(result!=null)?result.Success:f

8、alse;20. 其中GetTokenUrl是根据token和API的地址等参数，构建一个完整的提交地址。我们在上面代码通过 var postData = new userName = userName, userPassword = userPassword .ToJson();就可以动态创建一个对象，并生成它的JSON字符串，把数据POST提交到对应的API接口里面即可，然后对结果进行对象的转换就算完成了。3、集合和分页的处理在很多接口里面，我们都需要用到分页的处理，Web API也不例外，这样可以提交数据检索效率，减少服务器数据处理的压力，同时也提交客户端的数据显示速度。一般的集合接口定

9、义如下所示（通用性基类接口）。1. /2. /返回数据库所有的对象集合3. /4. /指定对象的集合5. HttpGet6. publicvirtualListGetAll(stringtoken)7. 8. /检查用户是否有权限，否则抛出MyDenyAccessException异常9. base.CheckAuthorized(AuthorizeKey.ListKey,token);10. 11. Listlist=baseBLL.GetAll();12. returnlist;13. 但是这样的返回记录会比较多，一般情况下需要分页，那么分页的处理接口定义如下所示。1. /2. /根据条件

10、查询数据库,并返回对象集合(用于分页数据显示)3. /4. /指定对象的集合5. HttpPost6. publicvirtualPagedListFindWithPager(stringcondition,PagerInfopagerInfo,stringtoken)分页接口，在这里返回的结果里面，用了一个PageList的泛型类，这个方便我们获取当前的记录及总数，它的定义如下所示。1. /2. /分页集合3. /4. /对象5. publicclassPagedList6. 7. /8. /返回记录的总数9. /10. publicinttotal_countget;set;11. 12.

11、 /13. /列表集合14. /15. publicListlistget;set;16. 最后整个分页的处理Web API接口实现如下所示。1. /2. /根据条件查询数据库,并返回对象集合(用于分页数据显示)3. /4. /指定对象的集合5. HttpPost6. publicvirtualPagedListFindWithPager(stringcondition,PagerInfopagerInfo,stringtoken)7. 8. /检查用户是否有权限，否则抛出MyDenyAccessException异常9. base.CheckAuthorized(AuthorizeKey.L

12、istKey,token);10. 11. Listlist=baseBLL.FindWithPager(condition,pagerInfo);12. 13. /构造成Json的格式传递14. varresult=newPagedList()total_count=pagerInfo.RecordCount,list=list;15. returnresult;16. 最后客户端调用分页的Web API代码如下所示。1. /2. /根据条件查询数据库,并返回对象集合(用于分页数据显示)3. /4. /查询的条件5. /分页实体6. /指定对象的集合7. publicvirtualListF

13、indWithPager(stringcondition,refPagerInfopagerInfo)8. 9. varaction=FindWithPager;10. stringurl=GetTokenUrl(action)+string.Format(&condition=0,condition);11. varpostData=pagerInfo.ToJson();12. 13. Listresult=newList();14. PagedListlist=JsonHelperPagedList.ConvertJson(url,postData);15. if(list!=null)1

14、6. 17. pagerInfo.RecordCount=list.total_count;/修改总记录数18. result=list.list;19. 20. returnresult;21. 4、混合框架界面整合Web API接口在整个Web API的平台构建以及在混合框架的整合过程中，我把各个模块还是遵循相对独立的方式进行开发和整合，它们实现了从直接访问数据库、以WCF服务获取数据，以及通过WebAPI调用方式获取数据几种方式的统一，从而实现了整个混合框架的高度整合。整个混合框架的核心是以相对独立的方式，整合各个可重用的模块，我们可以遵循一定的基础上，快速构建统一的应用平台。搭建完毕的整个WebAPI平台，其中包括了服务端内容，以API控制器的方式，发布了对应的Web