乐于分享
好东西不私藏

AI编程工具写前后端,如何让它们能联调通过?提示词需要注意哪些

AI编程工具写前后端,如何让它们能联调通过?提示词需要注意哪些

大家好,我是小强。
不知道大家用AI工具写代码是否有遇到前后端联调不通过,或者前后端生成的代码结构不一致,例如前端生成接口响应成功的code=0,而后端生成接口响应成功的code=200,导致前后端对接不上的问题。
虽然AI工具提高了我们的编程效率,但传统的一些生产流程我们还是不能省,最好是按照传统的软件生命周期进行开发,才不至于出问题。
一、传统的软件开发生命周期是怎样的呢?
1.产品经理下发需求,找UI生成原型图。然后找SE(架构师)、UI、需求涉及的上下游人员等进行需求宣讲。
2. SE使用基于架构的软件设计方法(ABSD):
根据原型图以及需求文档分析架构需求 -> 软件架构设计 -> 架构文档化,形成架构接口文档 ->根据设计的文档,召集专家人员进行复审。 这个过程是个迭代的过程。
3. 根据架构设计文档进行实现和演化
设计的接口文档如果全部满足原来的需求(包括产品功能需求、质量需求等)且审核没问题后,SE召集产品经理、前端、后端、测试等需求干系人进行宣讲,没问题后,交给前后端开发工程师实现。
二、以上就是开发的大致流程。而借助AI工具,我们可以用类似步骤:
1. 通过AI工具分析我们需求文档,生成一个高保真原型图或者能交互的Html静态页面
2.  用cursor、claude code、trae、codebuddy等AI编程工具,通过分析我们的原型界面,生成统一接口契约文档。参考提示词:
请严格根据我上传的产品原型图XXX,做完整业务拆解,只产出标准化接口文档,不要写任何代码。要求如下:1. 梳理所有页面、弹窗、表格、搜索栏、新增/编辑/删除/查询/下拉字典等全部交互动作;2. 为每一个交互动作生成独立REST接口,统一接口前缀 /api;3. 明确每个接口:请求地址、请求方式GET/POST/PUT/DELETE、业务说明;4. 每个接口附带标准JSON:请求入参、响应出参,标注字段类型、是否必填、字段释义;5. 统一规范:- 全部字段使用小驼峰命名;- 后端固定全局返回体:{"code":200,"data":{},"msg":"文字提示"};- 整理全部业务枚举、状态码、字典项(如启用/禁用、男女、订单状态);6. 结构清晰,分模块展示,方便直接复制给前端、后端AI分别开发使用。
3. 拿着同一份接口文档,同时发给前端 AI、后端 AI并行写代码。
给前端的提示词:
参照:1.我上传的原型图XXX 2.完整接口文档XXX,进行前端开发技术栈:Vue3 + Vite + Element Plus + 组合式API + Axios强制约束:1. 严格对齐接口文档:请求地址、请求方式、入参出参字段1:1不改动;2. 全局封装Axios,配置/api本地代理、请求头预留Token、响应拦截统一处理code;3. 页面布局、样式、交互完全还原原型图;4. 控制台打印完整请求与响应信息,方便联调;5. 空数据、异常场景、表单校验做兼容,代码可直接运行。
后端提示词:
参照完整接口文档XXX进行后端接口开发技术栈:springboot3+mybatis-plus+redis+satoken,数据库 mysql5.8,jdk版本为21强制约束:1. 接口路由、请求方式、入参出参结构严格和文档一致;2. 全局开启CORS跨域、统一/api前缀、JSON参数接收;3. 强制使用固定返回体:code、data、msg 结构;4. 编写模拟假数据,无需数据库即可启动运行;5. 打印请求参数与响应日志,方便前后端联调排错;6. 分层规范,代码可直接启动无报错。
将以上两套提示词模板以及生成的原型图和接口文档扔给AI后,就可以让他们同时开工,节省一半时间。并且严格遵从接口契约,基本就能一次联调通过,不会各干各的了。
三、其他特殊情况
或者有人问,我只是生成一个小的demo,也需要按这样的流程来做吗?
对于只是小的简单的demo项目,我们可以使用以下方式:
1. 还是先生成原型图。
2. 让AI工具直接根据原型图生成前后端代码,不用先生成接口。
参考提示词:
参照我上传的原型图XXX,一次性完成前后端开发:前端:Vue3 + Vite + Element Plus,组合式API,封装axios,自带/api代理后端:SpringBoot,全局跨域、统一返回体、模拟假数据要求:1. 前后端接口路径、字段、数据结构完全一致2. 所有接口REST风格,统一/api前缀3. 后端打印请求日志,前端打印请求响应4. 统一使用小驼峰、统一返回体 {code,data,msg}5. 写完可分别独立运行,支持本地直接联调
简单 CRUD、后台管理、列表表单类页面可以这样一次性生成,但复杂逻辑(权限、流程、联动、复杂计算)建议不要一步生成。
四、总结
1、对于正式项目,绝对不要前后端分开、各写各的接口。有如下弊端:
  • 容易出现两端 AI 各自脑补接口、字段、参数等;
  • 命名、数据结构、返回格式完全不统一;
  • 联调全是 404、参数缺失、字段 undefined,改到崩溃。
2、强制约束,契约先行。例如:

  • 字段:统一小驼峰;
  • 响应:固定 code/data/msg;
  • 后端:全局 CORS;
  • 前端:统一请求拦截、代理转发。
3、做正式项目、要快速联调、少改 bug:
原型 → 先出接口契约 → 前后端同时写
4、做小 demo、快速凑功能:
直接丢原型,AI 一次性生成全套前后端