mcpField
A
api-design-principles

api-design-principles

github.com/rmyndharis开发2.0k95 次安装1 天前更新
代码仓库

关于 api-design-principles

api-design-principles 是面向开发者和团队的技能，用于设计、评审和调整 REST 与 GraphQL API。它从使用者需求和 API 风格入手，涵盖错误处理、版本、分页及认证策略。

主要功能

  1. 01REST 与 GraphQL 设计指导
  2. 02依据使用者和约束规划 API
  3. 03错误、版本与分页策略
  4. 04通过示例验证一致性

适用场景

  1. 01设计新的 REST 或 GraphQL API
  2. 02评审实施前的 API 规范
  3. 03制定团队 API 设计标准

安装

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

$npx skills add https://github.com/rmyndharis/antigravity-skills --skill api-design-principles

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

包含的文件

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

assets/
api-design-checklist.md
rest-api-template.py
references/
graphql-schema-design.md
rest-best-practices.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