mcpField
A
api-design-principles

api-design-principles

github.com/sickn33开发48.8k1.0k 次安装今天更新
代码仓库

关于 api-design-principles

用于设计和评审 REST 与 GraphQL API 的指导技能，面向开发者和团队，涵盖 API 契约设计，并提供实现模式与检查清单。

主要功能

  1. 01REST 与 GraphQL 设计指导
  2. 02资源与类型建模
  3. 03错误、版本和分页策略
  4. 04规范示例与一致性审查
  5. 05实现模式与检查清单

适用场景

  1. 01规划新 API
  2. 02重构现有 API
  3. 03制定团队 API 标准
  4. 04审查 API 规范

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/sickn33/agentic-awesome-skills --skill api-design-principles

安装后在 Claude Code 中输入/api-design-principles确认已加载。

包含的文件

除 SKILL.md 外，安装时一起下载的参考资料和脚本。

assets/
api-design-checklist.md
rest-api-template.py
references/
rest-best-practices.md
graphql-schema-design.md
resources/
implementation-playbook.md

详细介绍

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

限制

  • 仅在任务明确符合上述范围时使用此技能。
  • 不要将输出视为针对特定环境的验证、测试或专家评审的替代品。
  • 如果缺少必要的输入、权限、安全边界或成功标准，请停下来并请求澄清。

评论

支持 Markdown