API设计原则指南：掌握REST与GraphQL设计，构建可扩展、易维护的API
api-design-principles by sickn33/antigravity-awesome-skills
安装命令
npx skills add https://github.com/sickn33/antigravity-awesome-skills --skill api-design-principles🇨🇳中文介绍
API 设计原则
掌握 REST 和 GraphQL API 设计原则，构建直观、可扩展且可维护的 API，让开发者满意并经受住时间的考验。
何时使用此技能
- 设计新的 REST 或 GraphQL API 时
- 为提升可用性而重构现有 API 时
- 为团队建立 API 设计标准时
- 在实施前审查 API 规范时
- 在 API 范式之间迁移时（例如从 REST 迁移到 GraphQL）
- 创建对开发者友好的 API 文档时
- 针对特定用例（如移动端、第三方集成）优化 API 时
何时不应使用此技能
- 你只需要特定框架的实现指导时
- 你正在进行不涉及 API 契约的纯基础设施工作时
- 你无法更改或版本化公共接口时
使用说明
- 定义消费者、用例和约束条件。
- 选择 API 风格并建模资源或类型。
- 指定错误处理、版本控制、分页和认证策略。
- 通过示例验证并审查一致性。
有关详细模式、检查清单和模板，请参阅 resources/implementation-playbook.md。
资源
resources/implementation-playbook.md包含详细模式、检查清单和模板。
每周安装次数
284
代码仓库
GitHub 星标数
27.1K
广告位招租
在这里展示您的产品或服务
触达数万 AI 开发者，精准高效
