feat(dev): 新增开发分析与设计 Skill
This commit is contained in:
@@ -0,0 +1,24 @@
|
||||
---
|
||||
name: prepare-api
|
||||
description: 对照前端需求或设计与现有 API 契约,整理接口清单、字段映射、类型转换、缺失项和联调风险。适用于前后端对接准备与契约差异分析;设计新 HTTP API、实现请求代码、运行接口调试或修改页面文案不应触发。
|
||||
---
|
||||
|
||||
# API 对接准备
|
||||
|
||||
把前端需要的数据与可验证 API 契约对应起来,明确差异而不编造接口或直接修改代码。
|
||||
|
||||
## 工作流
|
||||
|
||||
1. 按 [契约来源](references/sources.md) 确认 API 文档、服务端源码、生成规范或用户材料的范围、版本和可信度。
|
||||
2. 读取前端需求、页面设计或相关代码,提取用户可见含义、字段、动作和状态。
|
||||
3. 按 [映射规则](references/mapping.md) 建立接口、请求、响应和双向类型转换映射。
|
||||
4. 分别列出已匹配、未匹配、冲突、缺失接口和需要后端或产品确认的事项。
|
||||
5. 按 [评审清单](references/review.md) 检查错误、分页、精度、时间、空值、权限和兼容风险。
|
||||
6. 默认在对话中输出;用户要求保存时,先确认项目约定路径再写入。
|
||||
|
||||
## 边界
|
||||
|
||||
- API 文档不能反向覆盖已经确认的页面文案、业务含义和交互要求。
|
||||
- 不预设请求客户端、响应包裹、分页字段、枚举结构、上传或工作流接口。
|
||||
- 不因名称相似自动匹配字段;不确定项必须保留证据和待确认状态。
|
||||
- 本 Skill 不设计新 API、不发起真实请求、不生成正式请求代码,也不修改前后端实现。
|
||||
@@ -0,0 +1,4 @@
|
||||
interface:
|
||||
display_name: "接口准备"
|
||||
short_description: "整理前后端接口映射和契约差异"
|
||||
default_prompt: "使用 $prepare-api 分析前端需求与现有 API 契约的映射。"
|
||||
@@ -0,0 +1,11 @@
|
||||
# 映射规则
|
||||
|
||||
按页面动作建立接口清单,再分别映射请求和响应:
|
||||
|
||||
- 字段的业务含义、路径、必填条件、基数、空值和默认值。
|
||||
- 前端表示与传输类型,以及初始化和提交两个方向的转换。
|
||||
- 标识符精度、金额精度、日期时间格式与时区、枚举值域和嵌套结构。
|
||||
- 查询、分页、排序、筛选、批量和文件传输约定。
|
||||
- 成功、业务拒绝、输入错误、认证授权失败和系统失败的呈现需求。
|
||||
|
||||
名称不同但含义一致时记录映射证据;名称相同但含义或单位不同时列为冲突。未匹配字段和缺失接口必须完整保留,不用猜测值或临时 Mock 隐藏缺口。
|
||||
@@ -0,0 +1,11 @@
|
||||
# API 对接评审
|
||||
|
||||
- 每个页面动作是否有明确接口或缺失说明。
|
||||
- 请求方法、路径、参数位置和内容类型是否来自真实契约。
|
||||
- 请求与响应字段是否覆盖页面需要,未匹配项是否完整。
|
||||
- 双向转换是否处理精度、空值、时区、枚举和嵌套对象。
|
||||
- 分页、排序、批量和文件行为是否有契约依据。
|
||||
- 错误、权限、幂等、重复提交和并发更新是否可处理。
|
||||
- 契约版本、弃用、兼容期和环境差异是否说明。
|
||||
- 是否避免从 API 描述反向修改用户已确认的展示文案。
|
||||
- 未运行真实联调时,是否明确结果仅为静态契约分析。
|
||||
@@ -0,0 +1,11 @@
|
||||
# 契约来源
|
||||
|
||||
优先使用与目标环境和版本一致的契约:
|
||||
|
||||
1. 用户指定的正式 OpenAPI 或其他机器可读契约。
|
||||
2. 当前项目生成并用于目标环境的接口文档。
|
||||
3. 服务端控制器、请求响应模型、校验和契约测试。
|
||||
4. 经过项目维护的 Markdown 文档和示例。
|
||||
5. 用户明确说明的临时约定。
|
||||
|
||||
记录来源路径、版本或提交、生成时间和已知偏差。多个来源冲突时不自动裁决;列出冲突并由契约所有者确认。示例响应只能证明示例形态,不能代替完整字段约束。
|
||||
Reference in New Issue
Block a user