mcpField
A
api-design-principles

api-design-principles

github.com/davila7Development33.0k42 installsUpdated today
Repository

About api-design-principles

A skill for planning and reviewing REST and GraphQL APIs. It guides developers and teams through API style, resource or type models, errors, versioning, pagination, authentication, and consistency checks.

Key features

  1. 01REST and GraphQL design guidance
  2. 02Consumer and constraint analysis
  3. 03Resource and type modeling
  4. 04Errors, versioning, pagination, and auth
  5. 05Specification validation and review
  6. 06Implementation patterns and templates

Use cases

  1. 01Designing a new REST or GraphQL API
  2. 02Reviewing API specifications before implementation
  3. 03Setting team API design standards
  4. 04Planning API migrations or documentation

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/davila7/claude-code-templates --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