联调阶段的常见场景是:前端在等接口,后端在改字段,两边互相等待。等真正开始联调,又因为字段名、时间格式、空值处理不同而反复修改。
一、契约先行:先定文档再写代码
接口文档应当在开发开始前确定:路径、方法、请求参数、响应结构、错误码。双方确认后再各自开工,能并行推进。
- 文档即契约,改动要走确认流程
- 字段示例要写全,包括空值情况
- 分页、时间、枚举值等公共约定单独列出
二、Mock 数据让前端不等
- 前端按文档搭建 Mock,先完成界面与交互
- Mock 覆盖正常、空数据、异常三类场景
- 后端接口就绪后切换真实地址验证
空数据与异常场景先测
很多界面问题是"没有数据时显示什么"。用 Mock 先把这些情况过一遍,能避免上线后才发现空白页或错位。
三、环境与账号统一
- 联调使用统一的测试环境,不用各自的本地环境
- 准备一套测试账号与测试数据,注明数据含义
- 环境地址与配置写进文档,避免口头传递
四、联调方式约定
| 项目 | 约定建议 |
|---|---|
| 问题记录 | 统一在一个清单里登记,不散落在聊天记录 |
| 响应时效 | 约定问题响应时限,如当日内回复 |
| 联调时间 | 固定时段集中联调,避免碎片化等待 |
| 问题定位 | 先看请求日志与返回,再讨论责任 |
五、联调结束要留痕
联调完成后更新接口文档(与实际一致)、归档测试记录、把踩过的坑写进项目知识库。同一个坑踩两次,通常是因为第一次没人写下来。
#前后端联调#接口契约#协作流程#软件事业部