欢迎来到天天文库
浏览记录
ID：35319180
大小：1.06 MB
页数：10页
时间：2019-03-23
《webapi接口设计经验总结》由会员上传分享，免费在线阅读，更多相关内容在应用文档-天天文库。
1、WebAPI接口设计经验总结在WebAPI接口的开发过程中，我们可能会碰到各种各样的问题，我在前面两篇随笔《WebAPI应用架构在Winform混合框架中的应用（1）》、《WebAPI应用架构在Winform混合框架中的应用（2）--自定义异常结果的处理》也进行了总的介绍，在经过我的大量模块实践并成功运行后，总结了这篇随笔，希望对大家有所帮助。1、在接口定义中确定MVC的GET或者POST方式由于我们整个WebAPI平台是基于MVC的基础上进行的API开发，因此整个WebAPI的接口，在定义的时候，一
2、般需要显示来声明接口是[HttpGet]或者[HttpPost]，虽然有些接口也可以不用声明，但是避免出现类似下面的错误信息，显式声明还是有好处的。例如在基类定义的查找对象接口如下所示。1./// 2. /// 查询数据库,检查是否存在指定ID的对象 3. /// 4. /// 对象的ID值 5. /// 存在则返回指定的对象,否则返回N
3、ull 6. [HttpGet] 7. public virtual T FindByID(string id, string token) 如果是增删改的接口，一般需要声明为POST方式提交数据，而且基于安全性的考虑，需要携带更多的参数。1./// 2. /// 插入指定对象到数据库中 3. /// 4. /// 指定的对象4、ram> 5. /// 执行操作是否成功。 6. [HttpPost] 7. public virtual CommonResult Insert(T info, string token, string signature, string timestamp, string nonce, string appid) 2、动态对象的接口定义在一般的WebAPI接口里面，我们可能都会碰到很多简单类型的参数，但是又想让它们以5、POST方式提交数据，那么我们就可以有两种方法来处理，一种是定义一个类来放置这些参数，一种是采用动态的JObject参数，前者有很多不方便的地方，因为我们不可能为每个接口参数定义多一个实体类，这样可能会有很多难以管理的类定义。如下面是微信API的调用接口案例，我们也需要设置这样的处理规则。1.接口调用请求说明 2.http请求方式: POST（请使用https协议） 3.https://api.weixin.qq.com/cgi-bin/groups/update?access_token=ACCES6、S_TOKEN 4.POST数据格式：json 5.POST数据例子：{"group":{"id":108,"name":"test2_modify2"}} 那么我们采用JObject是这么样的呢，我们来看接口的定义和处理代码。JObject是Newtonsoft.Json.Linq命名空间下的一个对象。 1./// 2. /// 修改用户密码 3. /// 4. /// 包含u7、serName和userPassword的复合对象 5. /// 用户访问令牌 6. /// 7. [HttpPost] 8. public CommonResult ModifyPassword(JObject param, string token) 9. { 10. //令牌检查,不通过则抛出8、异常 11. CheckResult checkResult = CheckToken(token); 12. dynamic obj = param; 13. if (obj != null) 14. { 15. string userName = obj.userName; 16. string user
4、ram> 5. /// 执行操作是否成功。 6. [HttpPost] 7. public virtual CommonResult Insert(T info, string token, string signature, string timestamp, string nonce, string appid) 2、动态对象的接口定义在一般的WebAPI接口里面，我们可能都会碰到很多简单类型的参数，但是又想让它们以
5、POST方式提交数据，那么我们就可以有两种方法来处理，一种是定义一个类来放置这些参数，一种是采用动态的JObject参数，前者有很多不方便的地方，因为我们不可能为每个接口参数定义多一个实体类，这样可能会有很多难以管理的类定义。如下面是微信API的调用接口案例，我们也需要设置这样的处理规则。1.接口调用请求说明 2.http请求方式: POST（请使用https协议） 3.https://api.weixin.qq.com/cgi-bin/groups/update?access_token=ACCES
6、S_TOKEN 4.POST数据格式：json 5.POST数据例子：{"group":{"id":108,"name":"test2_modify2"}} 那么我们采用JObject是这么样的呢，我们来看接口的定义和处理代码。JObject是Newtonsoft.Json.Linq命名空间下的一个对象。 1./// 2. /// 修改用户密码 3. /// 4. /// 包含u
7、serName和userPassword的复合对象 5. /// 用户访问令牌 6. /// 7. [HttpPost] 8. public CommonResult ModifyPassword(JObject param, string token) 9. { 10. //令牌检查,不通过则抛出
8、异常 11. CheckResult checkResult = CheckToken(token); 12. dynamic obj = param; 13. if (obj != null) 14. { 15. string userName = obj.userName; 16. string user
此文档下载收益归作者所有
