Does this skill support both REST and GraphQL?

Yes, it provides comprehensive design principles and implementation patterns for both RESTful architectures and GraphQL schemas, allowing you to choose the best paradigm for your needs.

Is this skill specific to a certain programming language?

While the examples utilize Python and FastAPI, the core design principles are language-agnostic and can be applied to any backend framework like Node.js, Go, or Java.

How does it help with GraphQL performance?

The skill includes specific patterns for solving the common N+1 query problem using DataLoaders and implementing efficient Relay-style pagination for large datasets.

Can I use this for API versioning?

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

API Design Principles

Name: API Design Principles
Author: yusoofsh

byyusoofsh

0•

API Development

Builds intuitive, scalable, and maintainable REST and GraphQL APIs using industry-standard design patterns and best practices.

This skill empowers developers to architect high-quality backend interfaces by providing expert guidance on both REST and GraphQL paradigms. It streamlines the design process for new services, assists in reviewing existing specifications for usability, and helps establish organizational API standards. From resource-oriented architecture and HTTP method semantics to GraphQL schema-first development and solving the N+1 problem with DataLoaders, this skill ensures your backend services are developer-friendly, performant, and built to stand the test of time.

Key Features

01Schema-first GraphQL design with advanced Relay-style pagination

02Multiple API versioning strategies for long-term maintenance

03Comprehensive RESTful resource modeling and HTTP method implementation

04Standardized error handling and consistent HTTP status code mapping

05Advanced patterns for HATEOAS and DataLoader implementations

060 GitHub stars

Use Cases

01Architecting a new microservice API from the ground up

02Refactoring legacy endpoints to improve developer experience and consistency

03Migrating an existing REST infrastructure to a modern GraphQL implementation

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add yusoofsh/dotfiles api-design-principles

For use in Claude.ai and ChatGPT

Download Skill