How does it handle performance issues like N+1?

It includes specific patterns for implementing DataLoaders in GraphQL to batch requests and optimize data fetching, preventing common performance bottlenecks.

Can this help with existing API refactoring?

Absolutely. The skill provides guidance on identifying action-oriented endpoints and refactoring them into resource-oriented structures to improve usability and consistency.

Does it provide guidance on API versioning?

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

Does this skill support both REST and GraphQL?

Yes, it provides detailed design patterns and implementation examples for both RESTful resource-oriented architectures and GraphQL schema-first development.

API Design Principles

Name: API Design Principles
Author: HermeticOrmus

byHermeticOrmus

API開発

Master REST and GraphQL architectural patterns to build scalable, developer-friendly backend services.

概要

This skill provides comprehensive guidance on designing robust APIs using modern REST and GraphQL standards. It assists developers in implementing resource-oriented architectures, defining strongly-typed schemas, handling pagination, and preventing performance bottlenecks like the N+1 problem. Whether you are refactoring legacy endpoints or architecting a new microservice from scratch, this skill ensures your APIs are intuitive, maintainable, and adhere to industry best practices for the long term.

主な機能

RESTful resource-oriented architecture and HTTP method semantics
Advanced pagination, filtering, and HATEOAS implementation
Standardized error handling and status code mapping
Performance optimization techniques including DataLoader for N+1 prevention
0 GitHub stars
GraphQL schema-first development and resolver implementation patterns

ユースケース

Establishing team-wide API design standards and specification reviews
Migrating legacy action-oriented endpoints to modern resource-oriented architectures
Architecting new REST or GraphQL APIs for enterprise applications

概要

主な機能

RESTful resource-oriented architecture and HTTP method semantics
Advanced pagination, filtering, and HATEOAS implementation
Standardized error handling and status code mapping
Performance optimization techniques including DataLoader for N+1 prevention
0 GitHub stars
GraphQL schema-first development and resolver implementation patterns

ユースケース

Establishing team-wide API design standards and specification reviews
Migrating legacy action-oriented endpoints to modern resource-oriented architectures
Architecting new REST or GraphQL APIs for enterprise applications