⚡

API设计原则Skill api-design-principles

该技能专注于掌握REST和GraphQL API设计原则，帮助构建直观、可扩展和可维护的API，提升开发体验和系统可维护性。适用于API设计、架构审查、标准制定和文档优化，关键词包括API设计、REST、GraphQL、架构设计、API标准、开发者友好。

架构设计 0 次安装 0 次浏览 更新于 3/22/2026

name: API设计原则 description: 掌握REST和GraphQL API设计原则，以构建直观、可扩展和可维护的API，让开发者满意。用于设计新API、审查API规范或建立API设计标准。 license: MIT metadata: version: “1.0.0” domain: 架构 triggers: API设计, REST, GraphQL, API标准, API规范, API审查 role: 架构师 scope: 系统设计 output-format: 架构 related-skills: API模式, API安全最佳实践

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 获取详细模式、检查清单和模板。