admin 管理员组文章数量: 1087139
2024年3月22日发(作者：16进制转换文字)
在Web API接口的开发过程中，我们可能会碰到各种各样的问题，我在前面两篇随笔
《Web API应用架构在Winform混合框架中的应用（1）》、《Web API应用架构在
Winform混合框架中的应用（2）--自定义异常结果的处理》也进行了总的介绍，在经过
我的大量模块实践并成功运行后，总结了这篇随笔，希望对大家有所帮助。
1、在接口定义中确定MVC的GET或者POST方式
由于我们整个Web API平台是基于MVC的基础上进行的API开发，因此整个Web
API的接口，在定义的时候，一般需要显示来声明接口是[HttpGet]或者[HttpPost]，虽然
有些接口也可以不用声明，但是避免出现类似下面 的错误信息，显式声明还是有好处的。
例如在基类定义的查找对象接口如下所示。
1. userName, userPassword);
2. return new CommonResult(success);
3. }
4. else
5. {
6. throw new MyApiException("传递参数出现错误");
7. }
8. }
其中我们把JObject对象转换为我们所需要的对象的时候，因为我们没有定义具体的
实体类，因此采用了dynamic语法，声明这是一个动态对象，由运行时获取对应的属性。
dynamic obj = param;
这样我们就可以在调用的时候，动态POST对应的JSON对象给Web API接口，而
不需要预先定义各种接口参数的类了。
1. oJson();
2. string url = GetTokenUrl(action);
3. CommonResult result = JsonHelper
l, postData);
4. return (result != null) ? : false;
5. }
其中GetTokenUrl是根据token和API的地址等参数，构建一个完整的提交地址。
我们在上面代码通过
var postData = new { userName =
userName, userPassword = userPassword }.ToJson();
就可以动态创建一个对象，并生成它的JSON字符串，把数据POST提交到对应的API
接口里面即可，然后对结果进行对象的转换就算完成了。
3、集合和分页的处理
在很多接口里面，我们都需要用到分页的处理，Web API也不例外，这样可以提交数
据检索效率，减少服务器数据处理的压力，同时也提交客户端的数据显示速度。
一般的集合接口定义如下所示（通用性基类接口）。
1. onvertJson(url, postData);
2. if (list != null)
3. {
4. = ;//修改总记录数
5. result = ;
6. }
7. return result;
8. }
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设计的十大原则
版权声明：本文标题：webapi接口设计经验总结 内容由网友自发贡献，该文观点仅代表作者本人， 转载请联系作者并注明出处：http://roclinux.cn/p/1711092471a588052.html， 本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如发现本站有涉嫌抄袭侵权/违法违规的内容，一经查实，本站将立刻删除。
发表评论