本案例演示如何在前后端分离的项目中,利用 Codex 高效地为 Spring Boot 后端新增一个业务接口。
1. 任务背景
在现有的 Spring AI 实战项目中,需要新增一个“AI 智能推荐”接口,支持根据用户传入的关键词返回推荐的开发工具列表。
2. 第一步:定位核心链路
不要盲目猜测,先让 Codex 识别现有的后端架构。
Prompt 示例:
``text
请先只读分析后端代码结构,不要修改文件。
请告诉我:
- Controller 层的存放目录。
- 在 RecommendController 中新增 GET 方法。
- 只修改 Controller 和 Service 层。
- 接口自测:要求 Codex 生成一份用于 Postman 或 cURL 的测试指令。
- 异常检查:特意传入非法参数,观察 Codex 实现的异常处理是否生效。
2. Service 层和 Repository 层的关联关系。
3. 现有的 API 响应统一封装类(如 ResultEntity)在哪里。
4. 如果要新增一个 GET 接口 /api/recommend/items,我应该修改哪几个文件。
`
3. 第二步:编写执行计划
在 Codex 动手前,确认其理解了您的业务规范。
Prompt 示例:
`text
我准备新增 AI 推荐接口,计划如下:
2. 在 RecommendService 中实现调用 AI 模型获取推荐的逻辑。
3. 返回结果必须使用项目统一的 Result> 格式。
请评估该计划是否符合当前项目的代码风格,并指出潜在的依赖风险。
`
4. 第三步:受控的代码实施
要求 Codex 执行修改,并严格限制其对数据库或认证逻辑的改动。
Prompt 示例:
`text
请按计划实施修改。
限制要求:
2. 严禁修改数据库 Schema 或现有的 Security 配置。
3. 必须包含必要的参数校验(如 @RequestParam 不能为空)。
4. 完成后请总结本次新增的接口定义及 Diff。
``
5. 验收与调试
---
下一篇推荐:实战案例:让 Codex 修改一段接口逻辑 —— 学习如何安全地重构现有业务代码。