Does it cover error handling?

Yes, it provides standardized patterns for HTTP status codes, consistent error response structures, and validation error reporting to improve developer experience.

Is it specific to a certain programming language?

While the code examples use Python and FastAPI/Ariadne, the core design principles are language-agnostic and can be applied to any modern backend framework.

How does it help with API performance?

It includes patterns for efficient pagination and filtering in REST, as well as DataLoader implementations in GraphQL to prevent the common N+1 query problem.

Does this skill support both REST and GraphQL?

Yes, it provides comprehensive design patterns and implementation examples for both RESTful resource-oriented architectures and schema-first GraphQL services.

Can I use this for API versioning?

Absolutely. The skill covers multiple versioning strategies, including URL, header, and query parameter approaches, to help you maintain backward compatibility.

API Design Principles

Name: API Design Principles
Author: HermeticOrmus

byHermeticOrmus

0•

API 개발

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

This skill empowers developers to architect robust backends by applying best practices for both RESTful and GraphQL APIs. It provides comprehensive guidance on resource-oriented design, schema-first development, versioning strategies, and efficient data fetching techniques like pagination and the DataLoader pattern. Whether you are building a new microservice, refactoring legacy endpoints, or establishing team-wide API standards, this skill ensures your interfaces are developer-friendly, performant, and future-proof.

주요 기능

010 GitHub stars

02Performance optimization techniques including N+1 query prevention

03Schema-first GraphQL design with type safety and best practices

04Advanced implementation patterns for pagination, filtering, and error handling

05Version management strategies for long-term API maintenance

06Standardized RESTful resource-oriented architecture patterns

사용 사례

01Establishing consistent API design standards across development teams

02Migrating existing REST services to GraphQL or modernizing legacy endpoints

03Architecting new public-facing or internal API services

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add hermeticormus/floraheritage api-design-principles

For use in Claude.ai and ChatGPT

Download Skill