Is this skill compatible with FastAPI or other frameworks?

While it provides examples in FastAPI and Python, the core design principles are language-agnostic and applicable to any backend framework or language.

Can it help with API versioning?

Absolutely. The skill covers various versioning strategies including URL, header, and query parameter approaches to ensure backward compatibility.

Does it provide guidance on error handling?

Yes, it establishes a standardized approach for HTTP status codes and consistent error response structures to improve client-side integration and debugging.

Does this skill support both REST and GraphQL?

Yes, it provides comprehensive principles and implementation patterns for both RESTful resource-oriented architecture and GraphQL schema-first design.

How does it handle performance issues like N+1 queries?

It includes specific architectural patterns for using DataLoaders in GraphQL to batch requests and optimize data fetching efficiency.

API Design Principles

Name: API Design Principles
Author: HermeticOrmus

byHermeticOrmus

0•

Desarrollo de API

Design and implement high-quality REST and GraphQL APIs using industry-standard patterns and best practices.

This skill empowers developers to architect robust, scalable, and developer-friendly APIs by applying core RESTful and GraphQL design principles. It provides actionable patterns for resource modeling, pagination, error handling, versioning, and N+1 problem prevention. Whether you are building from scratch, refactoring legacy systems, or establishing team-wide standards, this skill ensures consistency and maintainability across your backend services while optimizing for both mobile and third-party integrations.

Características Principales

01Standardized RESTful resource modeling and HTTP method semantics

02Consistent error handling and status code mapping

030 GitHub stars

04Robust pagination and filtering implementation strategies

05Efficient data fetching with DataLoader to prevent N+1 queries

06Advanced GraphQL schema design and mutation patterns

Casos de Uso

01Designing a new microservice API from the ground up

02Migrating an existing REST API to a modern GraphQL architecture

03Refactoring inconsistent API endpoints for better developer experience

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add hermeticormus/after-the-third-cup api-design-principles

For use in Claude.ai and ChatGPT

Download Skill