api-design-principles

# API 设计原则 掌握 REST 和 GraphQL API 设计原则，构建直观、可扩展且易于维护的 API，让开发者感到愉悦并经得起时间的考验。 ## 何时使用此技能 - 设计新的 REST 或 GraphQL API - 重构现有 API 以提高可用性 - 为团队建立 API 设计标准 - 在实施前审查 API 规范 - 在 API 范式之间迁移（REST 到 GraphQL 等） - 创建对开发者友好的 API 文档 - 针对特定用例（移动端、第三方集成）优化 API ## 何时不使用此技能 - 你只需要特定框架的实现指南 - 你正在进行纯基础设施工作，不涉及 API 契约 - 你无法更改或版本化公共接口 ## 指令 1. 定义消费者、用例和约束。 2. 选择 API 风格并建模资源或类型。 3. 指定错误、版本控制、分页和认证策略。 4. 通过示例进行验证，并审查一致性。 参考 `resources/implementation-playbook.md` 获取详细的模式、检查清单和模板。 ## 资源 - `resources/implementation-playbook.md` 获取详细的模式、检查清单和模板。