用途:这是一套 API 设计原则与决策参考,目标是帮助开发者“思考”而非复制固定模式,适用于选择 API 风格、设计响应结构、规划版本演进与安全策略等场景。
主要能力:内容按主题分文件组织,可按需查阅。api-style.md 提供 REST vs GraphQL vs tRPC 的决策树;rest.md 涉及资源命名、HTTP 方法与状态码;response.md 涉及信封模式、错误格式与分页;graphql.md 涉及 Schema 设计、适用场景与安全;trpc.md 面向 TypeScript monorepo 与类型安全;versioning.md 涉及 URI/Header/Query 版本化;auth.md 涉及 JWT、OAuth、Passkey、API Keys 的选型;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 选型、响应与错误格式统一、分页与版本化设计、认证与限流方案选择、API 文档与安全审计准备。
限制:资料未提供具体实现代码、收费与平台支持信息;相关技能引用(如 nodejs-best-practices、database-design、vulnerability-scanner)仅为关联提示,具体内容暂未提供。