让你在 API 设计中少踩坑的实战分享

作者/分享人:奔跑吧架构师
向 Ta 提问
在互联网公司担任高级 Java 工程师、架构师、技术经理、技术负责人等职务。在工作期间,从零参与公司技术平台建设,组织平台进行过多次大架构升级。作为CSDN博客专家,平时爱写博客分享新的技术和收获,博客地址:http://blog.csdn.net/cml_blog

在项目开发中,实际的编码只占用了整个项目不到 30% 的时间,更多的时间都耗在了需求分析与接口设计上。每一次的需求变更就可能涉及到多个 API 的修改,那么 API 设计书作为项目开发的核心文档,如何才能让前端和移动端开发人员更快的理解参数的意义和作用、适应版本更新,以及保障数据的安全性呢?本场 Chat 将从以下几个方面进行分析说明:

  1. API 设计文档的规范,要怎么写清晰明了
  2. API 如何命名
  3. 如何做好 API 的版本控制,如何应部分 API 版本更新
  4. 如何防止数据被篡改
  5. token 方式的优缺点以及优化
  6. JWT 加密方式的使用场景
  7. 为何推荐在过滤器层做权限校验,以及如何使用 shiro 作为权限校验
  8. 为何不推荐使用拦截器
  9. 权限拦截的白名单规则
已有118人预订
预订达标
文章出炉
交流日期
     
11月22日
12月05日
12月13日 20:30
查看文章评论/提问
阳光
感觉这样设计API太麻烦了,时间全消耗在文档上了,这种开发模式适合走外包
奔跑吧架构师: 其实编码占项目的时间真的不多的,没有详细的文档,开发人员容易走偏路。而且运维的时候不一定是同一批人,后面的的人维护的成本也是非常高的。所以在一开始就要设计详细点的话能够为后面剩下很多时间的。
你可能还喜欢
Service Mesh 在华为公有云的实践
田晓亮
从零开始,搭建 AI 音箱 Alexa 语音服务
Mike
Web 安全恩仇录:再谈逻辑漏洞
肖志华
如何用 Vue 实现前端权限控制(路由权限 + 视图权限 + 请求权限)
雅X共赏
智能增长:如何用大数据和人工智能实现业务体量的增长
蒋凡
有关 Mock 的是是非非
思考的犀牛
微信扫描登录