Does this skill support both REST and GraphQL?

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

Does it include standardized error handling?

Yes, it provides standardized structures for error responses and consistent mappings for HTTP status codes to ensure your API communicates issues clearly to clients.

Can I use this for API versioning strategies?

Absolutely. It covers multiple versioning strategies including URL path, header-based, and query parameter versioning to help you manage API evolution without breaking changes.

How does this help with the GraphQL N+1 problem?

It includes specific implementation patterns for DataLoaders to batch and cache requests, ensuring efficient data fetching and preventing database performance bottlenecks.

API Design Principles

Name: API Design Principles
Author: wshobson

bywshobson

•

23,194

•

API Development

Masters REST and GraphQL design patterns to build scalable, intuitive, and developer-friendly backend architectures.

This skill provides expert guidance for architecting robust APIs using industry-standard RESTful and GraphQL patterns. It assists developers in establishing resource-oriented structures, implementing sophisticated pagination and filtering, managing versioning strategies, and solving complex GraphQL challenges like the N+1 problem with DataLoaders. Whether you are starting a new project or refactoring a legacy system, this skill ensures your API remains maintainable, performant, and delightful for third-party developers to consume.

Key Features

01Schema-first GraphQL development and Relay-style pagination

02Standardized RESTful resource and collection design patterns

03Advanced implementation patterns like HATEOAS and DataLoaders for N+1 prevention

04Robust error handling strategies and HTTP status code mappings

0523,194 GitHub stars

06API versioning methods including URL, header, and query parameters

Use Cases

01Establishing company-wide API design standards and developer documentation

02Migrating a legacy REST API to a modern GraphQL schema

03Designing a new scalable microservice architecture from scratch

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add wshobson/agents api-design-principles

For use in Claude.ai and ChatGPT

Download Skill