Does this skill support both REST and GraphQL?

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

Can I use this for API versioning?

Absolutely. It covers multiple versioning strategies including URL versioning, Header versioning, and Query Parameter versioning to help you maintain backward compatibility.

How does it handle the GraphQL N+1 problem?

The skill includes specific implementation patterns for DataLoaders, which batch and cache requests to ensure efficient data fetching and prevent performance bottlenecks.

Is this skill specific to a particular programming language?

While the design principles are language-agnostic, the skill provides implementation examples in Python and FastAPI to demonstrate real-world application.

API Design Principles

Name: API Design Principles
Author: Tahir-yamin

byTahir-yamin

•

API Development

Architects high-performance, developer-friendly REST and GraphQL APIs using industry-standard patterns and best practices.

The API Design Principles skill provides a comprehensive framework for building scalable and maintainable backend interfaces. It guides developers through resource-oriented REST architecture, semantic HTTP methods, and schema-first GraphQL development. By incorporating advanced patterns such as Relay-style pagination, HATEOAS, and DataLoader strategies for N+1 prevention, this skill ensures that your APIs are not only functional but also intuitive and optimized for the best possible developer experience.

Key Features

01Resource-oriented RESTful architecture implementation

02Standardized error handling and semantic HTTP status codes

03N+1 problem prevention using DataLoader patterns

04Multiple API versioning strategies for long-term maintenance

05Schema-first GraphQL design with Relay-style pagination

063 GitHub stars

Use Cases

01Refactoring existing endpoints to improve consistency and developer experience

02Architecting a new microservice API from the ground up

03Migrating legacy REST services to modern GraphQL schemas

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add tahir-yamin/dev-engineering-playbook api-design-principles

For use in Claude.ai and ChatGPT

Download Skill