Can I use this to refactor existing APIs?

Yes, it is designed to help identify action-oriented anti-patterns and suggest resource-oriented refactorings for better usability and maintenance.

How does it help with GraphQL performance?

It includes specific patterns for implementing DataLoaders to prevent the common N+1 query problem and suggests efficient pagination structures.

Which versioning strategies does it recommend?

The skill provides patterns for URL-based, Header-based, and Query Parameter versioning, helping you choose the best fit for your specific project needs.

Does this skill support specific programming languages?

The principles are language-agnostic, though the skill provides high-quality implementation examples for Python (FastAPI) and GraphQL Schema Definition Language (SDL).

What is the API Design Principles skill?

It is a specialized capability for Claude Code that provides domain-specific guidance for architecting professional-grade REST and GraphQL APIs.

API Design Principles

Name: API Design Principles
Author: HermeticOrmus

byHermeticOrmus

•

API開発

Architects and implements intuitive, scalable REST and GraphQL APIs using industry-standard design patterns and best practices.

概要

This skill empowers Claude to design high-quality APIs by providing deep expertise in both RESTful architectures and GraphQL schemas. It covers resource-oriented modeling, proper HTTP method usage, versioning strategies, and advanced patterns like HATEOAS and DataLoaders for N+1 prevention. Whether you are building a new backend from scratch, refactoring legacy endpoints for better developer experience, or establishing team-wide API standards, this skill ensures your interfaces are consistent, performant, and maintainable.

主な機能

Schema-first GraphQL design with Relay-style pagination
Advanced data fetching patterns including HATEOAS and DataLoaders
2 GitHub stars
Standardized error handling and HTTP status code mapping
Comprehensive API versioning and documentation strategies
Resource-oriented RESTful API modeling and naming

ユースケース

Designing a new RESTful backend using modern frameworks like FastAPI
Reviewing API specifications to ensure consistency and developer friendliness
Migrating existing legacy endpoints to a type-safe GraphQL schema

概要

主な機能

Schema-first GraphQL design with Relay-style pagination
Advanced data fetching patterns including HATEOAS and DataLoaders
2 GitHub stars
Standardized error handling and HTTP status code mapping
Comprehensive API versioning and documentation strategies
Resource-oriented RESTful API modeling and naming

ユースケース

Designing a new RESTful backend using modern frameworks like FastAPI
Reviewing API specifications to ensure consistency and developer friendliness
Migrating existing legacy endpoints to a type-safe GraphQL schema