在WebAPI接口的开发过程中，我们可能会碰到各种各样的问题，我在前面两篇随笔《WebAPI应用架构在Winform混合框架中的应用（1）》、《WebAPI应用架构在Winform混合框架中的应用（2）--自定义异常结果的处理》也进行了总的介绍，在经过我的大量模块实践并成功运行后，总结了这篇随笔，希望对大家有所帮助。
1、在接口定义中确定MVC的GET或者POST方式
由于我们整个WebAPI平台是基于MVC的基础上进行的API开发，因此整个WebAPI的接口，在定义的时候，一般需要显示来声明接口是[HttpGet]或者[HttpPost]，虽然有些接口也可以不用声明，但是避免出现类似下面的错误信息，显式声明还是有好处的。
例如在基类定义的查找对象接口如下所示。 1. 2. 3. 4. 5.
/// /// 查询数据库,检查是否存在指定ID的对象 ///
/// 对象的ID值 ///
6. [HttpGet] 7.
public virtual T FindByID(string id, string token)
如果是增删改的接口，一般需要声明为POST方式提交数据，而且基于安全性的考虑，需要携带更多的参数。 1. /// 2. /// 插入指定对象到数据库中 3. ///
4. /// 指定的对象 5. ///
7. public virtual CommonResult Insert(T info, string token, string signature, string timestamp, string nonce, string appid)
1
×××分厂×××安全生产工作履职清单及行动计划表--0202)89673 2、动态对象的接口定义
在一般的WebAPI接口里面，我们可能都会碰到很多简单类型的参数，但是又想让它们以POST方式提交数据，那么我们就可以有两种方法来处理，一种是定义一个类来放置这些参数，一种是采用动态的JObject参数，前者有很多不方便的地方，因为我们不可能为每个接口参数定义多一个实体类，这样可能会有很多难以管理的类定义。如下面是微信API的调用接口案例，我们也需要设置这样的处理规则。
1. 接口调用请求说明
2. http请求方式: POST（请使用https协议）
3. https://api.weixin.qq.com/cgi-bin/groups/update?access_token=ACCESS_TOKEN 4. POST数据格式：json 5. POST数据例子：
{\"group\":{\"id\":108,\"name\":\"test2_modify2\"}}
那么我们采用JObject是这么样的呢，我们来看接口的定义和处理代码。JObject是Newtonsoft.Json.Linq命名空间下的一个对象。
1. /// 2. /// 修改用户密码 3. ///
4. /// 包含userName和userPassword的复合对象
5. /// 用户访问令牌 6. ///
8. public CommonResult ModifyPassword(JObject param, string token) 9. {
10. //令牌检查,不通过则抛出异常
11. CheckResult checkResult = CheckToken(token);
12. dynamic obj = param;
2
×××分厂×××安全生产工作履职清单及行动计划表--0202)89673 13. if (obj != null) 14. {
15. string userName = obj.userName; 16. string userPassword = obj.userPassword; 17.
18. bool success = BLLFactory 19. return new CommonResult(success); 20. } 21. else 22. { 23. throw new MyApiException(\"传递参数出现错误\"); 24. } 25. } 其中我们把JObject对象转换为我们所需要的对象的时候，因为我们没有定义具体的实体类，因此采用了dynamic语法，声明这是一个动态对象，由运行时获取对应的属性。 dynamicobj=param; 这样我们就可以在调用的时候，动态POST对应的JSON对象给WebAPI接口，而不需要预先定义各种接口参数的类了。 1. /// 2. /// 调用Web API接口，修改用户密码 3. /// 4. /// 用户名称 5. /// 修改的密码 6. /// 7. public bool ModifyPassword(string userName, string userPassword) 8. { 3 ×××分厂×××安全生产工作履职清单及行动计划表--0202)89673 9. var action = \"ModifyPassword\"; 10. var postData = new 11. { 12. userName = userName, 13. userPassword = userPassword 14. }.ToJson(); 15. 16. string url = GetTokenUrl(action); 17. 18. CommonResult result = JsonHelper 19. return (result != null) ? result.Success : false; 20. } 其中GetTokenUrl是根据token和API的地址等参数，构建一个完整的提交地址。我们在上面代码通过 varpostData=new{userName=userName,userPassword=userPassword}.ToJson(); 就可以动态创建一个对象，并生成它的JSON字符串，把数据POST提交到对应的API接口里面即可，然后对结果进行对象的转换就算完成了。 3、集合和分页的处理 在很多接口里面，我们都需要用到分页的处理，WebAPI也不例外，这样可以提交数据检索效率，减少服务器数据处理的压力，同时也提交客户端的数据显示速度。 一般的集合接口定义如下所示（通用性基类接口）。 1. /// 2. /// 返回数据库所有的对象集合 3. /// 4. /// 6. public virtual List 7. { 4 ×××分厂×××安全生产工作履职清单及行动计划表--0202)89673 8. //检查用户是否有权限，否则抛出MyDenyAccessException异常 9. base.CheckAuthorized(AuthorizeKey.ListKey, token); 10. 11. List 但是这样的返回记录会比较多，一般情况下需要分页，那么分页的处理接口定义如下所示。 1. /// 2. /// 根据条件查询数据库,并返回对象集合(用于分页数据显示) 3. /// 4. /// 5. [HttpPost] 6. public virtual PagedList 分页接口，在这里返回的结果里面，用了一个PageList的泛型类，这个方便我们获取当前的记录及总数，它的定义如下所示。 1. /// 4. /// 7. /// 9. /// 10. public int total_count { get; set; } 11. 5 ×××分厂×××安全生产工作履职清单及行动计划表--0202)89673 12. /// 14. /// 15. public List 最后整个分页的处理WebAPI接口实现如下所示。 1. /// 2. /// 根据条件查询数据库,并返回对象集合(用于分页数据显示) 3. /// 4. /// 5. [HttpPost] 6. public virtual PagedList 8. //检查用户是否有权限，否则抛出MyDenyAccessException异常 9. base.CheckAuthorized(AuthorizeKey.ListKey, token); 10. 11. List 13. //构造成Json的格式传递 14. var result = new PagedList 最后客户端调用分页的WebAPI代码如下所示。 1. /// 6 ×××分厂×××安全生产工作履职清单及行动计划表--0202)89673 2. /// 根据条件查询数据库,并返回对象集合(用于分页数据显示) 3. /// 4. /// 查询的条件 5. /// 分页实体 6. /// 9. var action = \"FindWithPager\"; 10. string url = GetTokenUrl(action) + string.Format(\"&condition={0}\", condition); 11. var postData = pagerInfo.ToJson(); 12. 13. List 14. PagedList 17. pagerInfo.RecordCount = list.total_count;//修改总记录数 18. result = list.list; 19. } 20. return result; 21. } 4、混合框架界面整合WebAPI接口 在整个WebAPI的平台构建以及在混合框架的整合过程中，我把各个模块还是遵循相对独立的方式进行开发和整合，它们实现了从直接访问数据库、以WCF服务获取数据，以及通过WebAPI调用方式获取数据几种方式的统一，从而实现了整个混合框架的高度整合。 7 ×××分厂×××安全生产工作履职清单及行动计划表--0202)89673 整个混合框 架的核心是以相对独立的方式，整合各个可重用的模块，我们可以遵循一定的基础上，快速构建统一的应用平台。 8 ×××分厂×××安全生产工作履职清单及行动计划表--0202)89673 搭建完毕的 整个WebAPI平台，其中包括了服务端内容，以API控制器的方式，发布了对应的WebAPI接口。 9 ×××分厂×××安全生产工作履职清单及行动计划表--0202)89673 在每个混合框架的独立模块里面， 我们封装了对应的WebAPI客户端调用处理，从而实现了WebAPI的调用方式。 在Win10下，使用WebAPI模式运行 混合框架，获得的主体界面效果如下所示。 10 ×××分厂×××安全生产工作履职清单及行动计划表--0202)89673 独立模块 权限管理系统界面如下所示。 < 【编辑推荐】 1. Web前端开发与iOS终端开发的异同 2. 针对Web网页性能管理详细的解说 3. Web开发人员常犯的10个错误 4. Web开发者不容错过的10个HTML5工具 11 ×××分厂×××安全生产工作履职清单及行动计划表--0202)89673 优秀API设计的十大原则 学会低调，取舍间必有得失，不用太计较。学着踏实而务实，越努力越幸运。 12 因篇幅问题不能全部显示，请点此查看更多更全内容