更新+mock部分
This commit is contained in:
21
.agents/skills/k12-api-response-standard/SKILL.md
Normal file
21
.agents/skills/k12-api-response-standard/SKILL.md
Normal file
@@ -0,0 +1,21 @@
|
||||
---
|
||||
name: k12-api-response-standard
|
||||
description: 当任务涉及前后端接口联调、请求封装、异常处理时使用,统一 code/message/data/traceId 响应体契约
|
||||
---
|
||||
# K12 统一响应体技能
|
||||
## 何时使用
|
||||
- 新增或改造后端 API
|
||||
- 改动前端/小程序请求层
|
||||
- 修复“后端已报错但前端当成功处理”的联调问题
|
||||
## 统一契约
|
||||
- 响应体结构固定为:`code/message/data/traceId`
|
||||
- 成功条件:`code === 0`
|
||||
- 业务失败:`code !== 0`,前端应抛错并使用 `message` 透出
|
||||
## 执行步骤
|
||||
1. 后端控制器与异常处理统一返回 `ApiResponse`。
|
||||
2. 前端与小程序请求封装统一校验 `code` 字段,不仅依赖 HTTP 状态码。
|
||||
3. 新接口落地时同步检查类型声明与调用方数据解包方式,避免重复定义结构。
|
||||
4. 同步更新 `docs/architecture/api-design.md` 中响应体约定,保持文档与代码一致。
|
||||
## 约束
|
||||
- 不引入破坏性字段重命名(如把 `message` 改为 `msg`)。
|
||||
- 保留 `traceId` 以支持链路追踪。
|
||||
17
.agents/skills/k12-comment-header-standard/SKILL.md
Normal file
17
.agents/skills/k12-comment-header-standard/SKILL.md
Normal file
@@ -0,0 +1,17 @@
|
||||
---
|
||||
name: k12-comment-header-standard
|
||||
description: 当任务涉及注释模板、global.code-snippets 或 .fileheader 配置时使用,确保 author 与当前仓库 git user.name 对齐
|
||||
---
|
||||
# K12 注释头规范技能
|
||||
## 何时使用
|
||||
- 用户要求统一文件头/函数注释规范
|
||||
- 用户要求 `@author` 与 git 用户名一致
|
||||
- 任务涉及 `global.code-snippets` 或 `.fileheader/fileheader.config.yaml`
|
||||
## 执行步骤
|
||||
1. 读取仓库 `git config user.name`,以此作为 `author` 基线。
|
||||
2. 更新 `global.code-snippets` 中 `FileHeader` 与 `Method` 的 author 默认值。
|
||||
3. 若项目使用 `turbo-file-header`,检查 `.fileheader/fileheader.config.yaml` 的 `@author` 字段,确保与团队约定一致。
|
||||
4. 修改后验证 JSON/YAML 可解析,避免因注释模板格式错误导致编辑器失效。
|
||||
## 约束
|
||||
- 不修改业务逻辑代码,只处理注释与模板规范。
|
||||
- 需要保留已有注释字段顺序(description/filename/author/copyright/since)。
|
||||
22
.agents/skills/k12-restful-api-style/SKILL.md
Normal file
22
.agents/skills/k12-restful-api-style/SKILL.md
Normal file
@@ -0,0 +1,22 @@
|
||||
---
|
||||
name: k12-restful-api-style
|
||||
description: 当任务涉及接口命名、路径规划或网关转发时使用,统一 K12Study 的 RESTful 风格并强制旧接口不兼容
|
||||
---
|
||||
# K12 RESTful 接口风格技能
|
||||
## 何时使用
|
||||
- 新增 API 设计
|
||||
- 旧接口路径改造(如 `current-user`、`* /tree`)
|
||||
- 需要同步网关白名单与客户端调用路径
|
||||
## 设计规则
|
||||
- 路径优先使用资源名(名词)而不是动作名。
|
||||
- 集合资源使用复数:`/users`、`/departments`。
|
||||
- “当前用户”使用语义路径:`/users/current`。
|
||||
- 树形结构优先通过资源路径表达:`/areas`、`/tenants`、`/departments`。
|
||||
## 执行步骤
|
||||
1. 在控制器中提供 RESTful 主路径。
|
||||
2. 删除旧路径映射,不保留兼容别名。
|
||||
3. 同步更新前端、小程序 API 调用路径。
|
||||
4. 同步更新鉴权白名单与文档(`docs/architecture/api-design.md`、`docs/architecture/logical-view.md`)。
|
||||
## 约束
|
||||
- 保持网关 `/api/*` 统一入口不变。
|
||||
- 旧接口不兼容,禁止新增或恢复旧路径别名。
|
||||
Reference in New Issue
Block a user