SKILL

api-design-principles

掌握 REST 和 GraphQL API 设计原则，构建直观、可扩展且可维护的 API，让开发者满意并经得起时间考验。

译文已校对

查看英文原文

Master REST and GraphQL API design principles to build intuitive, scalable, and maintainable APIs that delight developers and stand the test of time.

适用对象：设计与内容创作。自动收录 · 待核查。

原作者说明节选

从固定版本的 SKILL.md 提取，保留原文语言。以下内容属于作者说明，本站尚未验证安装、兼容或运行结果。

查看英文原文

原文涵盖的主题

API Design Principles
Use this skill when
Do not use this skill when
Instructions
Resources

Master REST and GraphQL API design principles to build intuitive, scalable, and maintainable APIs that delight developers and stand the test of time. 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) 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 1. Define consumers, use cases, and constraints. 2. Choose API style and model resources or types. 3. Specify errors, versioning, pagination, and auth strategy. 4. Validate with examples and review for consistency. Refer to resources/implementation-playbook.md for detailed patterns, checklists, and templates. resources/implementation-playbook.md for detailed patterns, checklists, and templates.

来源仓库: davila7/claude-code-templates
源文件: cli-tool/components/skills/development/api-design-principles/SKILL.md
固定版本: 21be197f100a12b8d0dd9a211cc244c8179f84d3

阅读完整原作者说明 ↗