下载地址
https://www.zhengdianxue.com/wp-content/uploads/skills/org-02qudk26--api-patterns.zip将提示词发送给你的 AI 安装该 skills
请根据 https://skillhub.cn/install/skillhub.md，安装 @org-02qudk26/api-patterns。REST/GraphQL/tRPC 的 API 设计决策模式。
阅读全文 （展开查看完整说明）
概述
2025 年的 API 设计原则与决策方法。
学会思考，而非照搬固定模式。
🎯 选择性阅读规则
只阅读与请求相关的文件！ 查看内容地图，找到你需要的内容。
📑 内容地图
| 文件 | 描述 | 阅读时机 |
|---|---|---|
api-style.md | REST vs GraphQL vs tRPC 决策树 | 选择 API 类型时 |
rest.md | 资源命名、HTTP 方法、状态码 | 设计 REST API 时 |
response.md | 信封模式、错误格式、分页 | 响应结构设计 |
graphql.md | Schema 设计、何时使用、安全 | 考虑 GraphQL 时 |
trpc.md | TypeScript monorepo、类型安全 | TS 全栈项目 |
versioning.md | URI/Header/Query 版本管理 | API 演进规划 |
auth.md | JWT、OAuth、Passkey、API Keys | 鉴权模式选型 |
rate-limiting.md | 令牌桶、滑动窗口 | API 防护 |
documentation.md | OpenAPI/Swagger 最佳实践 | 文档编写 |
security-testing.md | OWASP API Top 10、鉴权/授权测试 | 安全审计 |
🔗 相关技能
| 需求 | 技能 |
|---|---|
| API 实现 | @[skills/backend-development] |
| 数据结构 | @[skills/database-design] |
| 安全细节 | @[skills/security-hardening] |
✅ 决策检查清单
在设计 API 之前：
- [ ] 已向用户确认 API 调用方？
- [ ] 针对当前场景选择了 API 风格？（REST/GraphQL/tRPC）
- [ ] 定义了统一的响应格式？
- [ ] 规划了版本管理策略？
- [ ] 考虑了鉴权需求？
- [ ] 规划了速率限制？
- [ ] 定义了文档方案？
❌ 反模式
不要：
- 对所有场景默认使用 REST
- 在 REST 端点中使用动词（如 /getUsers）
- 返回不一致的响应格式
- 向客户端暴露内部错误
- 跳过速率限制
应当：
- 基于场景选择 API 风格
- 询问客户端需求
- 编写详尽文档
- 使用恰当的状态码
脚本
| 脚本 | 用途 | 命令 |
|---|---|---|
scripts/api_validator.py | API 端点校验 | python scripts/api_validator.py <project_path> |
