概述
一些API设计心得，记下来，以后有空拿来评测新写的代码
基本：
- API名称自描述；
- 单一职能，针对的是变化的维度，而不是最小功能；
- 如果同步执行的速度太慢，考虑提供异步执行和可查询结果两个接口(或提供回调功能)
参数：
- 参数名作为API的补充，自描述；
- 参数保持最少暴露，方便扩展；
- 字段的值域，用有意义的单词，禁用0、1、2这样的数字；
返回值：
- （待商榷）需要预留，调用状态的成功/失败，和执行结果的成功/失败，两个描述符；
- 返回错误代码不如返回错误文字描述，毕竟失败就是失败；
最后
以上就是洁净飞机为你收集整理的WebApi设计关键点(个人)的全部内容，希望文章能够帮你解决WebApi设计关键点(个人)所遇到的程序开发问题。
如果觉得靠谱客网站的内容还不错，欢迎将靠谱客网站推荐给程序员好友。
本图文内容来源于网友提供，作为学习参考使用，或来自网络收集整理，版权属于原作者所有。
发表评论 取消回复