Does this skill support both REST and GraphQL?

Yes, it provides comprehensive patterns and best practices for both RESTful resource-oriented architecture and schema-first GraphQL development.

Can it help with API versioning?

Absolutely. it covers multiple versioning strategies including URL, header, and query parameter versioning to ensure long-term API stability and backward compatibility.

How does it handle large datasets?

The skill includes specific implementation patterns for pagination, filtering, and the DataLoader pattern to optimize performance and prevent N+1 query issues.

Is it compatible with specific Python frameworks?

While the principles are language-agnostic, the skill provides specific code examples for popular frameworks like FastAPI and Ariadne to accelerate implementation.

API Design Principles

Name: API Design Principles
Author: HermeticOrmus

byHermeticOrmus

0•

API 开发

Implements industry-leading REST and GraphQL standards to build intuitive, scalable, and developer-friendly backend services.

This skill equips Claude with deep expertise in modern API architecture, enabling the creation of robust REST and GraphQL interfaces. It provides structured guidance on resource-oriented modeling, schema-first GraphQL development, efficient pagination, and standardized error handling. Whether you are refactoring legacy endpoints or building greenfield microservices, this skill ensures your APIs follow best practices like HATEOAS, idempotent HTTP methods, and N+1 query prevention using DataLoaders, ultimately improving developer experience and long-term maintainability.

主要功能

01Standardized RESTful resource modeling and HTTP method semantics

02Schema-first GraphQL design with type-safe mutations and queries

03Robust error handling frameworks with consistent status codes

040 GitHub stars

05Advanced pagination and filtering patterns for high-performance data retrieval

06N+1 problem prevention techniques using the DataLoader pattern

使用场景

01Refactoring existing endpoints to improve consistency and developer usability

02Architecting new backend services with clear, scalable API specifications

03Migrating services from traditional REST architectures to strongly-typed GraphQL schemas

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add hermeticormus/hermetic-line api-design-principles

For use in Claude.ai and ChatGPT

Download Skill