How does this skill handle API versioning?

It includes strategies for URL versioning, header-based versioning, and query parameter versioning to help you manage long-term API evolution.

Are the patterns specific to one programming language?

While the principles are universal, the skill provides concrete implementation examples using Python-based tools like FastAPI and Pydantic for immediate application.

Does this skill support both REST and GraphQL?

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

Can it help optimize GraphQL performance?

Yes, it provides specific patterns for implementing DataLoaders to batch and cache requests, effectively solving the N+1 query problem.

API Design Principles

Name: API Design Principles
Author: Activer007

byActiver007

•

Desarrollo de API

Architects intuitive and scalable REST and GraphQL interfaces using industry-standard design patterns and best practices.

This skill serves as a comprehensive guide for developers looking to build professional-grade APIs that are both maintainable and developer-friendly. It covers the full spectrum of API architecture, from resource-oriented RESTful design and HTTP semantics to schema-first GraphQL development. By utilizing this skill, you can implement sophisticated patterns for pagination, filtering, and error handling, while also learning how to solve complex backend challenges like the N+1 problem using DataLoaders. Whether you are establishing team-wide standards or refactoring existing services, this skill ensures your API remains robust and scalable over time.

Características Principales

01Resource-oriented RESTful architecture and HTTP method semantics

02Schema-first GraphQL development with strong typing and introspection

03Advanced pagination strategies including Relay-style cursor pagination

04Optimized data fetching patterns using DataLoaders to prevent N+1 issues

056 GitHub stars

06Standardized error handling with consistent HTTP status code mapping

Casos de Uso

01Establishing unified API design standards and documentation for engineering teams

02Designing new REST or GraphQL APIs for enterprise-scale applications

03Migrating legacy systems between different API paradigms (e.g., REST to GraphQL)

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add activer007/ordinary-claude-skills api-design-principles

For use in Claude.ai and ChatGPT

Download Skill