How does this skill help with API performance?

It includes specific patterns for efficient pagination, filtering, and the implementation of DataLoaders to prevent the common N+1 query problem in GraphQL.

Are there code examples included?

Yes, the skill provides implementation patterns using Python (FastAPI/Pydantic) and standard GraphQL schema definitions.

Can I use this for API versioning strategy?

Absolutely. The skill covers multiple versioning approaches including URL-based, Header-based, and Query Parameter versioning to help you choose the right path for your project.

Does this skill support both REST and GraphQL?

Yes, it provides detailed design patterns and best practices for both RESTful resource-oriented architectures and GraphQL schema-first development.

API Design Principles

Name: API Design Principles
Author: carloscroc

bycarloscroc

0•

API開発

Designs and reviews RESTful and GraphQL APIs using industry-standard patterns for scalability, maintainability, and developer experience.

This skill provides a comprehensive framework for architecting high-quality APIs, bridging the gap between basic endpoints and professional-grade services. It offers domain-specific guidance on resource-oriented architecture for REST, schema-first development for GraphQL, and robust patterns for pagination, versioning, and error handling. Whether you are building a new backend from scratch or refactoring legacy systems, this skill helps ensure your API is intuitive, performant, and follows modern best practices like HATEOAS and DataLoader implementations to prevent N+1 query problems.

主な機能

01Multiple API versioning strategies (URL, Header, and Query Parameter)

020 GitHub stars

03GraphQL schema-first design with Relay-style pagination

04Standardized error handling and HTTP status code mapping

05Performance optimization patterns including DataLoaders and batching

06RESTful resource-oriented architecture and HTTP method semantics

ユースケース

01Establishing team-wide API design standards and specification reviews

02Refactoring legacy endpoints into a standardized, developer-friendly API

03Architecting a new backend service with a consistent resource model

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add carloscroc/fitness api-design-principles

For use in Claude.ai and ChatGPT

Download Skill