用途:这是一套 API 设计原则与决策参考技能,目标是帮助开发者根据具体场景做出设计选择,而不是照搬固定模式。
主要能力:内容按主题分文件组织,包括 api-style.md(REST、GraphQL、tRPC 的决策树)、rest.md(资源命名、HTTP 方法、状态码)、response.md(信封模式、错误格式、分页)、graphql.md(Schema 设计、适用场景、安全)、trpc.md(TypeScript monorepo 与类型安全)、versioning.md(URI/Header/Query 版本管理)、auth.md(JWT、OAuth、Passkey、API Key 选择)、rate-limiting.md(令牌桶、滑动窗口)、documentation.md(OpenAPI/Swagger 实践)、security-testing.md(OWASP API Top 10、认证与授权测试)。
使用方式:技能建议按需选择性阅读,先查看内容地图,只读取与当前请求相关的文件。设计前可对照决策清单:是否询问过 API 消费方、是否为当前上下文选定风格、是否定义一致的响应格式、是否规划版本策略、是否考虑认证与限流、是否确定文档方案。另提供脚本 scripts/api_validator.py,用于 API 端点验证,命令为 python scripts/api_validator.py <project_path>。
适用场景:REST/GraphQL/tRPC 选型、REST 接口设计、响应与错误格式统一、API 版本演进、认证与限流方案选择、接口文档编写、API 安全审计。
限制:资料未提供具体收费、平台支持范围或效果保证;相关技能(后端开发、数据库设计、安全加固)仅以引用形式出现,具体内容暂未提供。