前端 ↔ 后端 协作模板
场景:前端后端都用 AI 生成代码时,接口对不上是最高频的协作事故。核心对策——接口契约先行,AI 按契约生成,而非各写各的再对接。
一、接口契约先行
- 联调前先定接口契约(OpenAPI / Swagger / 类型定义),作为双方 AI 生成的唯一依据。
- 契约包含:路径、方法、请求 / 响应结构(字段名、类型、是否必填、示例)、错误码。
- 契约提交版本控制,变更走 PR(同代码一样审)。
二、Mock 并行开发
- 契约定稿后,后端未实现时前端用 Mock 先行,后端用契约生成接口骨架。
- 双方对着同一份契约开发,联调时差异最小化。
- AI 可基于契约自动生成 Mock + 接口调用代码(减少手写样板)。
三、契约变更通知
- 任何契约变更必须通知对方(不能一方改了接口,另一方上线才发现挂了)。
- 不兼容变更走版本号 / 过渡期,给对方适配时间。
- 变更原因记进 commit / PR(为什么改、影响谁)。
四、检查清单
五、常见坑
- ❌ 边写边定接口(前端按想象调,后端按另一套实现,联调炸)
- ❌ 后端偷偷改字段,前端上线白屏
- ❌ 契约只存在某个人脑子里(换人就丢)