一. 前言
你是否在为如何制定前后端协作规范而发愁?干货来啦,一文带你了解我们团队内部沉淀并践行已久的前后端协作规范,读完本文,回去大胆拒绝你后端的不合理设计!
二. 为什么需要协作规范?
假如你要在团队内部推一套规范,那么首先你得知道为什么需要制定协作规范呢?有规范会带来什么好处呢?
随着前后端分离开发模式大行其道,前端和后端已经在两个方向上渐行渐远,各自深耕细作、术业专攻。前端更加关注交互视觉体验,而后端对高并发、高性能、高扩展上要求更高。这就导致大部分的前端和后端之间会存在所谓的 “代沟”,我不知道你的数据如何存储,你不知道我的页面如何渲染。
因此,很有必要制定前后端开发上的规范来抹平代沟,有了协作规范,便有了前后端开发默契,也因此达到了提高开发效率、降低沟通成本的作用。
三. 协作流程规范
首先是协作的流程规范,相信每个团队在前后端协作中都有各自的开发模式和开发流程来保障效率和质量,我们团队的前后端协作大致流程如下图所示:

- 需求导入、交互视觉导入分析 :对产品导出的需求,参会各方包括产品、前端、后端、测试、UED,在对需求的认知上要达成一致,这是开发的第一步。
- 接口设计、前后端对接接口:后端给出接口,前后端要在接口字段设计上达成大致方向上的一致。
- 技术方案评审 :在开发之前进行技术方案评审,再次确保各方在需求的认知上统一,并且双方就接口字段可行性上再次确认。
- 并行开发 、前后端自测:前后端并行开发,在此阶段前端可以 mock 数据进行页面渲染。
- 开发环境联调:前后端自测完成之后在开发环境上完成接口联调。
四. 如何做接口规范?
- 前置约定:
- 后端接口定义 URL、出入参之前,前后端需达成一致。
- 文档规范:
- 接口注释需要写清楚:模块、枚举、必填 / 非必填、出参是否可能为 null
- 接口需要向下兼容,如果不兼容需要评估并且通知相应的业务方
- 接口文档上面有变更需及时同步前端
- 后端需保证文档上定义的参数,可以正常请求接口且功能正常稳定
- 计量单位约定:
- 时间:统一使用 13 位时间戳
- 金额:统一为分,可根据业务情况选择
- 请求接口 URL & 请求方式
- Post 接口不允许使用 Get 传参方式
- Post 接口必须使用
application/json 模式
- 接口命名应尽量符合语义,接口命名不要过于相似,难区分,易混淆
- 入参
- 保证同一应用领域内,相同含义的字段,命名保持一致
- 业务编号 / ID 必须为字符串类型,JS 对最大数字有限制
- 同一个页面不同 Tab,接口尽量保证一致