Can it help with performance issues like the N+1 problem?

Absolutely. It includes specific patterns for using DataLoaders in GraphQL to batch requests and optimize data fetching from your database.

How does it handle API versioning?

It covers multiple versioning strategies including URL path versioning, custom headers, and query parameters to ensure backward compatibility and smooth migrations.

Does this skill support both REST and GraphQL?

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

How does it improve developer experience (DX)?

By promoting consistent naming conventions, proper HTTP status codes, and descriptive error responses that make APIs intuitive and predictable for frontend developers.

Is this skill specific to a particular programming language?

While the provided code examples often use Python and FastAPI, the core design principles are architectural and apply to any backend language or framework.

API Design Principles

Name: API Design Principles
Author: duanbiao2000

byduanbiao2000

0•

API 개발

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

This skill empowers developers to build robust backend interfaces by providing comprehensive guidance on RESTful resource modeling, GraphQL schema-first development, and essential implementation patterns. It covers critical architectural topics including standardized versioning, pagination, HATEOAS, and N+1 query prevention using DataLoaders. Whether you are designing a new microservice architecture or refactoring a legacy system, this skill ensures your APIs are maintainable, performant, and provide a superior developer experience.

주요 기능

01GraphQL schema-first development including types, queries, and mutations

02Performance optimization techniques like DataLoader for N+1 prevention

030 GitHub stars

04Advanced implementation patterns for pagination, filtering, and HATEOAS

05Standardized API versioning strategies for long-term compatibility

06RESTful resource-oriented architecture and HTTP method semantics

사용 사례

01Refactoring legacy endpoints to improve usability and documentation

02Migrating an existing REST service to a strongly-typed GraphQL schema

03Designing a new microservices architecture with consistent API contracts

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add duanbiao2000/obsidiandoc26 api-design-principles

For use in Claude.ai and ChatGPT

Download Skill