build-backend-api-design
Installation
SKILL.md
API Design — REST/HTTP 接口合约设计
这个 Skill 不是负责写 API 实现,而是负责在实现前冻结 API 合约:资源、端点、DTO、错误、权限、分页、幂等、并发、兼容性和合约测试。
入口/出口
- 入口: 需要定义新 API 端点、修改已有端点合约、或设计跨服务 HTTP 合约
- 出口:
- API 端点列表(method + path + 认证 + 权限)
- Request / Response DTO
- Error Code 列表
- 权限与认证规则
- 分页 / 排序 / 过滤规则
- 幂等性与并发控制规则
- Zod / TypeScript / OpenAPI schema
- Contract Tests 最低覆盖
- 指向: 接口稳定后进入实现(
build-workflow-execute) - 前置加载: CANON.md +
build-quality-tdd/SKILL.md