mcpField
A
api-design-principles

api-design-principles

github.com/sickn33Development48.8k1.0k installsUpdated today
Repository

About api-design-principles

A guidance skill for designing and reviewing REST and GraphQL APIs. It helps developers and teams shape API contracts, with a playbook for implementation patterns and checklists.

Key features

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

Use cases

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

Install

Copy the command and run it in a terminal.

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

After installing, type/api-design-principlesin Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

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

Details

From the project README

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

  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

  • resources/implementation-playbook.md for detailed patterns, checklists, and templates.

Limitations

  • Use this skill only when the task clearly matches the scope described above.
  • Do not treat the output as a substitute for environment-specific validation, testing, or expert review.
  • Stop and ask for clarification if required inputs, permissions, safety boundaries, or success criteria are missing.

Comments

Markdown supported