如何设计优美的 WEB API?

作者/分享人:老顽童
向 Ta 提问
一个工作近十五年的程序员老兵,架构设计是我的专业,培训授课是我的爱好。微信公众号:技术宅爱分享,记录职业发展的探索与思考,分享跨界转型的经历与感悟,欢迎感兴趣的朋友关注交流!

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

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

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

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

已有237人预订
预订达标
文章出炉
     
04月28日
05月14日
本场 Chat 文章已出炉,购买后即可阅读文章并获得一张老顽童的读者圈Pass
请务必添加GitChat服务号以查看活动进度及获取活动通知。
查看文章评论/提问
xiangang
文章存在一些错别字哦,估计是作者笔误吧~
老顽童: 👍 ,我再Review一遍,谢谢!
老顽童: “单次” 应该是“单词”。
你可能还喜欢
基于深度学习的计算机视觉技术在无人驾驶中的应用
美团技术团队
1小时搞懂 Git 版本控制
Fengy
AutoML 在推荐系统中的应用
第四范式技术团队
Kibana Canvas 初探
medcl
今夜,我们聊聊中国的开源
开源社
统一认证与授权在微服务架构中的设计与实战
CANGWU
微信扫描登录