Agent Skills
› rmyndharis/antigravity-skills
› api-design-principles
api-design-principles
GitHub掌握REST和GraphQL API设计原则，构建直观、可扩展且易维护的API。适用于新API设计、现有API重构、制定团队标准、规范审查及迁移场景，旨在提升开发者体验。
触发场景
设计新的REST或GraphQL API
优化现有API以提升可用性
为团队建立API设计规范
实施前审查API规格说明
在API范式间进行迁移
安装
npx skills add rmyndharis/antigravity-skills --skill api-design-principles -g -y
SKILL.md
Frontmatter
{
"name": "api-design-principles",
"description": "Master REST and GraphQL API design principles to build intuitive, scalable, and maintainable APIs that delight developers. Use when designing new APIs, reviewing API specifications, or establishing API design standards."
}
API Design Principles
Master REST and GraphQL API design principles to build intuitive, scalable, and maintainable APIs that delight developers and stand the test of time.
Use this skill when
- Designing new REST or GraphQL APIs
- Refactoring existing APIs for better usability
- Establishing API design standards for your team
- Reviewing API specifications before implementation
- Migrating between API paradigms (REST to GraphQL, etc.)
- Creating developer-friendly API documentation
- Optimizing APIs for specific use cases (mobile, third-party integrations)
Do not use this skill when
- You only need implementation guidance for a specific framework
- You are doing infrastructure-only work without API contracts
- You cannot change or version public interfaces
Instructions
- Define consumers, use cases, and constraints.
- Choose API style and model resources or types.
- Specify errors, versioning, pagination, and auth strategy.
- Validate with examples and review for consistency.
Refer to resources/implementation-playbook.md for detailed patterns, checklists, and templates.
Resources
resources/implementation-playbook.mdfor detailed patterns, checklists, and templates.
版本历史
- e63f7dd 当前 2026-07-05 09:27
