如何设计优美的 WEB API?

作者/分享人:老顽童
向 Ta 提问
哈尔滨工业大学计算机硕士,近十五年工作经验,曾服务过中兴通讯、中国移动等企业,目前就职于某知名金融科技公司的专家团队,兼职人才发展管理委员会和企业大学授权讲师,面向内外部客户提供咨询和培训服务。微信公众号:技术宅爱分享,微博:技术宅爱分享,记录职业发展的探索与思考,分享跨界转型的经历与感悟,欢迎朋友们关注交流!

构建前后端分离的 WEB 应用或跨终端的移动应用、集成内外部系统、对外开放服务、开发可嵌入其他网页微件等,这些场景都离不开 WEB API。虽然我们经常使用他人提供的 WEB API,但如何评判它们的优劣呢?我们也经常设计开发 WEB API,但如何让它们更易于使用、方便更改和牢固健壮呢?

在设计 WEB API 的过程中,我们需要确定它的调用地址、请求方式(HTTP 方法)、请求参数(Headers/Query/Body)、数据格式、错误码、认证方式等内容,这当中存在不少标准规范,你都熟悉吗?你是否遇到过这些问题:

  • 如何让 URI 易懂易记、便于修改?
  • 如何最大程度地利用 HTTP 协议?
  • 如何通过查询参数实现搜索分页?
  • 如何选择数据格式和数据结构?
  • 如何通过状态码表示出错信息?
  • 如何规划 API 的版本和更新策略?
  • 如何让对外开放的 API 安全可靠?
  • ……

作者在建设 API 网关和市场过程中积累不少实战经验,有兴趣来听一听吗?

已有196人预订
预订达标
文章出炉
     
04月28日
05月14日
本场 Chat 文章已出炉,购买后即可阅读文章并获得一张老顽童的读者圈Pass
请务必添加GitChat服务号以查看活动进度及获取活动通知。
查看文章评论/提问
xiangang
文章存在一些错别字哦,估计是作者笔误吧~
老顽童: 👍 ,我再Review一遍,谢谢!
老顽童: “单次” 应该是“单词”。
你可能还喜欢
关于为何以及如何阅读源码的一点心得
追梦
从零开始,轻松打造你的聊天机器人
微软公开课
每周一个机器学习小项目001:全链接层实现与分类问题
如是
通过前端团队管理谈谈技术管理的技法与思想
常新居士
朋友圈爆款背后的计算机视觉技术与应用
AI科技大本营
为什么说 Java 程序员到了必须掌握 Spring Boot 的时候?
纯洁的微笑
微信扫描登录