skill整理-检查生成产品图接口
之前一直感觉ai识别产品图升成接口肯定不靠谱,最近自己尝试把产品图的列表和编辑新增都给codex,然后让他检查我的现在接口或者字段是否有遗漏,还真给我意想不到的惊喜,他是先询问我确定修改项,然后等我回复确定哪些了再进行修改,也调教了好几回,下面是调用文档
## PRD 对接口验收 Skill
本项目已新增一个用于“根据 PRD 检查接口是否满足需求”的 skill:
- Skill 文件:`.agent/skills/prd-api-gap-check/SKILL.md`
- Skill 名称:`PRD API Gap Check`
### 适用场景
当你需要对照 PRD 页面检查后端代码是否满足需求时使用,重点覆盖:
- 接口是否齐全(列表/详情/新增/编辑/删除/同步等)
- 返回字段是否足够支撑页面渲染
- 按钮行为是否与接口副作用一致(例如“同步库存”是否落库)
- 默认值和必填校验是否与 PRD 一致
### 调用方式(直接复制)
把 PRD(截图或文字)和目标 controller 路径发给 AI,并明确要求使用该 skill:
> 请使用 `PRD API Gap Check` 这个 skill,检查 `ShopProductController` 是否满足这份 PRD。
> Controller 路径:`src/main/java/com/chimeta/platform/controller/ShopProductController.java`
> 请输出:已覆盖项、缺口项(P0/P1/P2)、建议改动点、需要我确认的决策项。
### 推荐输出要求
为提高可执行性,建议每次都要求 AI 额外输出:
- 具体定位(文件 + 方法)
- 最小改动方案(尽量只改 service/controller)
- 至少一次编译验证结果(如 `gradlew compileJava`)
下面是skill文档
---
name: PRD API Gap Check
description: 对照商品或后台管理PRD检查后端接口是否满足需求。用于检查controller/service是否提供足够接口、返回字段是否覆盖页面展示和表单字段、按钮行为是否与接口副作用一致(如同步库存是否落库)、默认值与状态流是否符合PRD,并输出按优先级排序的缺口清单和修改建议。
---
# PRD API Gap Check
执行“PRD 对接口验收”时,按下面流程输出结果,避免只做“有无接口”的表层检查。
## 1. 输入与目标
- 输入:PRD截图或描述、目标controller文件路径、相关模块目录。
- 目标:确认是否“接口足够 + 字段足够 + 行为正确 + 默认值正确”。
## 2. 检查流程
1. 抽取PRD信息
- 拆出页面维度:列表页、详情页、新增/编辑页。
- 拆出需求维度:字段、按钮动作、状态流、默认值、展示型元信息(创建人/时间、更新人/时间)。
2. 建立PRD-接口映射矩阵
- 为每一项PRD需求映射到:controller方法、service方法、AO/DTO/VO、entity字段。
- 若controller中未找到,继续全局检索其他controller或通用接口(如上传接口)。
3. 覆盖性检查
- 接口覆盖:是否存在对应API。
- 字段覆盖:入参是否支持、返回是否包含前端渲染所需字段。
- 操作覆盖:新增、编辑、删除、详情、列表、刷新/同步类操作是否完整。
4. 语义一致性检查
- 接口名与行为是否一致(例如“同步库存”是否真正更新数据库)。
- 软删除/状态变更是否与页面“删除/上下架”语义一致。
- 错误码与异常信息是否可被前端正确消费。
5. 默认值与约束检查
- PRD默认值(如库存默认1)是否在后端落地。
- 必填校验是否覆盖PRD标注的必填项。
- 时间、人名等元信息是否可回显。
## 3. 输出格式
按以下结构输出,便于研发排期:
- 结论摘要:是否满足PRD(完全满足/部分满足/不满足)。
- 已覆盖项:按页面列出。
- 缺口清单:按P0/P1/P2分级,给出文件+方法定位。
- 改动建议:最小改动方案,优先根因修复。
- 待确认项:仅保留会影响实现路径的关键决策。
## 4. 严重级别定义
- P0:直接阻断需求上线(关键接口缺失、关键字段缺失、按钮语义错误)。
- P1:不阻断但会造成体验或数据不一致(默认值偏差、非关键字段缺失)。
- P2:优化项(命名、文档、返回结构可读性)。
## 5. 验证要求
- 至少执行一次最小编译验证(如 `gradlew compileJava`)。
- 若改动涉及行为语义(如同步、状态流),至少给出一条可执行的接口调用示例用于联调。
## 6. 实现约束(新增)
- 不要直接引用 dao 来查询;如果需要跨表或补充查询,请在对应 service 中新增方法,并由上层调用对应表的 service 方法。
- 做尽可能小的更改;和当前需求无关的代码不要动。

浙公网安备 33010602011771号