mcpField
A
api-design-principles

api-design-principles

github.com/rmyndharisDevelopment2.0k95 installsUpdated 1d ago
Repository

About api-design-principles

api-design-principles is a skill for teams and developers designing, reviewing, or revising REST and GraphQL APIs. It guides decisions from consumer needs and API style through errors, versioning, pagination, and authentication.

Key features

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

Use cases

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

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/rmyndharis/antigravity-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/
graphql-schema-design.md
rest-best-practices.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.

Comments

Markdown supported