Does this skill support both REST and GraphQL?

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

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

Absolutely. It includes specific implementation patterns for using DataLoaders to batch requests and prevent N+1 query issues in GraphQL.

What programming languages are the examples in?

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

Does it cover API versioning?

Yes, it outlines multiple versioning strategies including URL, Header, and Query Parameter methods to help your API evolve without breaking client integrations.

How does it handle API error consistency?

It defines standardized error response structures and HTTP status code mappings to ensure your API provides clear, actionable feedback to developers.

API Design Principles

Name: API Design Principles
Author: kivilaid

bykivilaid

•

Desarrollo de API

Master REST and GraphQL API design to build intuitive, scalable, and developer-friendly backend services.

Acerca de

This skill empowers developers to architect high-quality APIs by providing domain-specific guidance on RESTful resource modeling and GraphQL schema-first development. It offers production-ready implementation patterns for essential features like pagination, filtering, consistent error handling, and HATEOAS, while also addressing advanced GraphQL challenges like N+1 prevention with DataLoaders. Whether you are designing a new service from scratch or refactoring an existing one, this skill ensures your API remains maintainable, versionable, and optimized for diverse client needs.

Características Principales

RESTful resource-oriented architecture modeling and HTTP method semantics
GraphQL schema-first design including types, mutations, and subscriptions
6 GitHub stars
Standardized patterns for pagination, filtering, and robust error handling
Advanced API versioning strategies for long-term maintainability
Performance optimization techniques like N+1 prevention using DataLoaders

Casos de Uso

Designing a new REST or GraphQL API from scratch using industry best practices
Refactoring legacy API endpoints to improve developer experience and consistency
Establishing organization-wide API standards and reviewing technical specifications

Acerca de

Características Principales

RESTful resource-oriented architecture modeling and HTTP method semantics
GraphQL schema-first design including types, mutations, and subscriptions
6 GitHub stars
Standardized patterns for pagination, filtering, and robust error handling
Advanced API versioning strategies for long-term maintainability
Performance optimization techniques like N+1 prevention using DataLoaders

Casos de Uso

Designing a new REST or GraphQL API from scratch using industry best practices
Refactoring legacy API endpoints to improve developer experience and consistency
Establishing organization-wide API standards and reviewing technical specifications