Does this skill cover both REST and GraphQL?

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

How does this skill help with API performance?

It includes specific implementation patterns for N+1 problem prevention using DataLoaders and efficient pagination strategies like Relay-style connections.

Does it provide code examples for specific frameworks?

While the principles are universal, the skill includes practical implementation examples using Python frameworks like FastAPI and Ariadne.

Can I use this for API versioning strategy?

Yes, it outlines and compares multiple versioning strategies including URL versioning, header versioning, and query parameter approaches.

API Design Principles

Name: API Design Principles
Author: Activer007

byActiver007

0•

API 开发

Architects robust REST and GraphQL APIs using industry-standard design patterns, pagination strategies, and best practices for developer experience.

This skill provides comprehensive guidance on designing scalable, maintainable, and developer-friendly APIs using both REST and GraphQL paradigms. It offers concrete implementation patterns for resource-oriented architecture, complex query structures, pagination, versioning, and N+1 problem prevention. Whether you are building a new service from scratch, refactoring legacy endpoints, or establishing team-wide standards, this skill ensures your API remains intuitive and follows modern architectural standards.

主要功能

01Advanced pagination and filtering implementation strategies

02Performance optimization via DataLoaders for N+1 problem prevention

03GraphQL schema-first design and type-safe resolver patterns

04Standardized error handling and consistent HTTP status code usage

050 GitHub stars

06RESTful resource-oriented architecture and HTTP method semantics

使用场景

01Migrating legacy REST endpoints to a modern GraphQL architecture

02Designing a new microservice API with a focus on developer experience

03Reviewing and auditing API specifications for scalability and consistency

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