团队规范之前后端协作规范

1、为什么要前后端协作规范？

随着 前后端分离开发模式 的流行，前端和后端已经在各自领域上渐行渐远；

我们把前后端共同研发的一个需求所产生的关联称之为 联调；

美其名曰联调，如何去把控好这个联调的品质就是我们值得关注的点了 ~

稍不注意就很可能产生不必要的问题。

因此，咱们就很有必要 制定前后端协作规范 来解决这些问题了 ~

前后端协作规范的意义：

• 提高开发效率；

• 降低沟通成本；

• 提升团队和谐；

2、协作规范流程

• 需求分析。确保大家对需求有一致的认知；

• 设计接口文档。前端需要确认是否符合要求；

• 并行开发。前端需要根据接口文档进行Mock, 模拟对接后端接口；联调之前，要求后端做好接口测试；

• 真实环境联调。前端将接口请求代理到后端服务，进行真实环境联调；

3、接口规范

• 版本号；

• 接口注释与字段的描述；

• 具体接口定义：

• 方法名称或者 URI

• 方法描述

• 请求参数及其描述，必须说明类型(数据类型、是否可选等)

• 响应参数及其描述, 必须说明类型(数据类型、是否可选等)

• 可能的异常情况、错误代码、以及描述

• 请求示例，可选

• URI 结尾不应包含（/）；

• 正斜杠分隔符（/）必须用来指示层级关系；

• 应使用连字符（-）来提高URI的可读性

• 不得在URI中使用下划线（_）；

• URI路径中全都使用小写字母

• 具体详见：RESTful 架构详解

• GET：获取对应的信息；

• POST：用于创建或者某些资源的提交；

• UPDATE：更新某些资源；

• DELETE：删除某个资源；

• OPTIONS：对请求的校验，与 POST 配合；

• 接口风格使用 RESTful 风格；

• 请求方法规范：

• 其它规范：

• 接口文档规范：

4、注意点

• 明确数据类型、空值的意义以及默认值；

• 对于大数字（整数大于 16 位、浮点数大于 18 位）做字符串处理；

• 关于日期时间格式；

• 响应避免冗余的嵌套；

• 接口版本化，保持向下兼容；接口不兼容时需升级版本；

• 鉴权通过header实现；

• 其它……

---

新时代农民工