Web-API接口设计经验总结.doc

Web API接口设计经验总结在Web API接口的开发过程中，我们可能会碰到各种各样的问题，我在前面两篇随笔Web API应用架构在Winform混合框架中的应用（1）、Web API应用架构在Winform混合框架中的应用（2）-自定义异常结果的处理也进行了总的介绍，在经过我的大量模块实践并成功运行后，总结了这篇随笔,希望对大家有所帮助。1、在接口定义中确定MVC的GET或者POST方式由于我们整个Web API平台是基于MVC的基础上进行的API开发,因此整个Web API的接口，在定义的时候，一般需要显示来声明接口是HttpGet或者HttpPost,虽然有些接口也可以不用声明,但是避免出现类似下面 的错误信息，显式声明还是有好处的.例如在基类定义的查找对象接口如下所示。1. /summary2. /查询数据库,检查是否存在指定ID的对象3. /4. /paramname=id对象的ID值5. /returns存在则返回指定的对象,否则返回Null/returns6. HttpGet7. publicvirtualTFindByID(stringid，stringtoken)如果是增删改的接口，一般需要声明为POST方式提交数据，而且基于安全性的考虑，需要携带更多的参数。1. /summary2. /插入指定对象到数据库中3. /4. /paramname=”info”指定的对象5. /执行操作是否成功。2. /修改用户密码3. /4. /包含userName和userPassword的复合对象/param5. /paramname=”token”用户访问令牌/param6. /returns7. HttpPost8. publicCommonResultModifyPassword(JObjectparam，stringtoken）9. 10. /令牌检查，不通过则抛出异常11. CheckResultcheckResult=CheckToken（token)；12. dynamicobj=param;13. if(obj！=null)14. 15. stringuserName=obj.userName；16. stringuserPassword=obj.userPassword；17. 18. boolsuccess=BLLFactoryUser。Instance。ModifyPassword（userName,userPassword）;19. returnnewCommonResult（success);20. 21. else22. 23. thrownewMyApiException（”传递参数出现错误”）;24. 25. 其中我们把JObject对象转换为我们所需要的对象的时候,因为我们没有定义具体的实体类，因此采用了dynamic语法，声明这是一个动态对象，由运行时获取对应的属性。dynamicobj = param；这样我们就可以在调用的时候，动态POST对应的JSON对象给Web API接口，而不需要预先定义各种接口参数的类了。1. /summary2. /调用WebAPI接口,修改用户密码3. /summary4. /paramname=”userName”用户名称/param5. /修改的密码/param6. /如果修改成功返回true，否则返回false7. publicboolModifyPassword(stringuserName,stringuserPassword)8. 9. varaction=”ModifyPassword;10. varpostData=new11. 12. userName=userName，13. userPassword=userPassword14. 。ToJson（)；15. 16. stringurl=GetTokenUrl（action);17. 18. CommonResultresult=JsonHelperCommonResult。ConvertJson（url，postData);19. return（result！=null)?result。Success:false；20. 其中GetTokenUrl是根据token和API的地址等参数，构建一个完整的提交地址。我们在上面代码通过varpostData = new userName=userName， userPassword=userPassword .ToJson（);就可以动态创建一个对象，并生成它的JSON字符串，把数据POST提交到对应的API接口里面即可，然后对结果进行对象的转换就算完成了。3、集合和分页的处理在很多接口里面,我们都需要用到分页的处理，Web API也不例外，这样可以提交数据检索效率，减少服务器数据处理的压力，同时也提交客户端的数据显示速度。一般的集合接口定义如下所示(通用性基类接口)。1. /summary2. /返回数据库所有的对象集合3. /summary4. /returns指定对象的集合/returns5. HttpGet6. publicvirtualListTGetAll(stringtoken)7. 8. /检查用户是否有权限，否则抛出MyDenyAccessException异常9. base.CheckAuthorized(AuthorizeKey.ListKey，token)；10. 11. ListTlist=baseBLL.GetAll(）；12. returnlist；13. 但是这样的返回记录会比较多，一般情况下需要分页，那么分页的处理接口定义如下所示.1. /2. /根据条件查询数据库,并返回对象集合(用于分页数据显示）3. /summary4. /指定对象的集合/returns5. HttpPost6. publicvirtualPagedListFindWithPager（stringcondition，PagerInfopagerInfo,stringtoken)分页接口，在这里返回的结果里面,用了一个PageList的泛型类，这个方便我们获取当前的记录及总数，它的定义如下所示。1. /summary2. /分页集合3. /summary4. /typeparamname=”T对象/typeparam5. publicclassPagedListT6. 7. /8. /返回记录的总数9. /summary10. publicinttotal_countget；set;11. 12. /15. publicListTlistget;set;16. 最后整个分页的处理Web API接口实现如下所示。1. /summary2. /根据条件查询数据库,并返回对象集合（用于分页数据显示)3. /5. HttpPost6. publicvirtualPagedListTFindWithPager(stringcondition，PagerInfopagerInfo,stringtoken）7. 8. /检查用户是否有权限，否则抛出MyDenyAccessException异常9. base。CheckAuthorized(AuthorizeKey。ListKey，token）;10. 11. ListTlist=baseBLL。FindWithPager(condition,pagerInfo);12. 13. /构造成Json的格式传递14. varresult=newPagedListT（）total_count=pagerInfo.RecordCount,list=list；15. returnresult；16. 最后客户端调用分页的Web API代码如下所示。1. /summary2. /根据条件查询数据库,并返回对象集合（用于分页数据显示)3. /summary4. /paramname=”condition”查询的条件5. /paramname=”pagerInfo分页实体/param6. /指定对象的集合/returns7. publicvirtualListTFindWithPager（stringcondition，refPagerInfopagerInfo）8. 9. varaction=FindWithPager”；10. stringurl=GetTokenUrl（action）+string.Format(condition=0,condition）;11. varpostData=pagerInfo。ToJson(）;12. 13. ListTresult=newListT(）;14. PagedListTlist=JsonHelperPagedListT。ConvertJson（url,postData);15. if(list！=null)16. 17. pagerInfo.RecordCount=list。total_count；/修改总记录数18. result=list。list；19. 20. returnresult;21. 4、混合框架界面整合Web API接口在整个Web API的平台构建以及在混合框架的整合过程中，我把各个模块还是遵循相对独立的方式进行开发和整合，它们实现了从直接访问数据库、以WCF服务获取数据，以及通过WebAPI调用方式获取数据几种方式的统一，从而实现了整个混合框架的高度整合.整个混合框架的核心是以相对独立的方式，整合各个可重用的模块，我们可以遵循一定的基础上，快速构建统一的应用平台。搭建完毕的整个WebAPI平台，其中包括了服务端内容，以API控制器的方式，发布了对应的Web API接口。在每个混合框架的独立模块里面,我们封装了对应的Web API客户端调用处理,从而实现了Web API的调用方式。在Win10下，使用Web API模式运行混合框架，获得的主体界面效果如下所示.独立模块权限管理系统界面如下所示。【编辑推荐】1. Web前端开发与iOS终端开发的异同2. 针对Web网页性能管理详细的解说3. Web开发人员常犯的10个错误4. Web开发者不容错过的10个HTML5工具5. 优秀API设计的十大原则