工作流规范
为啥需要规范?
-
降低新成员融入团队的成本, 同时也一定程度避免挖坑
-
提高开发效率、团队协作效率, 降低沟通成本
-
实现高度统一的代码风格,方便review, 另外一方面可以提高项目的可维护性
-
规范是实现自动化的基础
-
规范是一个团队知识沉淀的直接输出
版本规范
前后端协调规范
协作流程规范

-
需求分析。参与者一般有前后端、测试、以及产品。由产品主持,对需求进行宣贯,接受开发和测试的反馈,确保大家对需求有一致的认知
-
前后端开发讨论。讨论应用的一些开发设计,沟通技术点、难点、以及分工问题.
-
设计接口文档。可以由前后端一起设计;或者由后端设计、前端确认是否符合要求
-
并行开发。前后端并行开发,在这个阶段,前端可以先实现静态页面;或者根据接口文档对接口进行Mock, 来模拟对接后端接口
-
在联调之前,要求后端做好接口测试真实环境联调。前端将接口请求代理到后端服务,进行真实环境联调。
接口规范
RESTful: RESTful是目前使用最为广泛的API设计规范, 基于HTTP本身的机制来实现.
⚠️:接口设计注意点
- 明确区分正常与异常的情况
- 明确数据类型,减少前端转化
- 明确空值的意义
- 响应避免冗余的嵌套