Can it help with existing API refactoring?

Absolutely. It offers guidance on mapping actions to HTTP verbs and improving resource hierarchies to make legacy APIs more intuitive and standards-compliant.

Does it address API performance?

Yes, it includes specific patterns for efficient pagination, filtering, and techniques like the DataLoader pattern to prevent N+1 query issues in GraphQL.

How does it handle API versioning?

The skill covers multiple industry-standard strategies including URL-based, header-based, and query parameter versioning to ensure long-term API maintainability.

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.

API Design Principles & Architecture

Name: API Design Principles & Architecture
Author: HermeticOrmus

byHermeticOrmus

0•

API開発

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

This skill empowers developers to build production-grade APIs by providing comprehensive guidance on RESTful resource-oriented architecture and GraphQL schema-first development. It streamlines the design process for new services, assists in refactoring legacy endpoints, and ensures consistent implementation of error handling, versioning, and pagination strategies. By integrating these principles directly into the Claude Code workflow, developers can ensure their backend services are maintainable, developer-friendly, and optimized for performance from the initial design phase through to implementation.

主な機能

01RESTful Resource-Oriented Architecture (ROA) guidance

02GraphQL Schema-First development and resolver optimization

03Standardized error handling and HTTP status code mapping

04Advanced techniques for HATEOAS and N+1 problem prevention

05Scalable pagination and filtering implementation patterns

060 GitHub stars

ユースケース

01Designing a new greenfield microservice API from scratch

02Modernizing legacy backend endpoints to follow RESTful standards

03Migrating a REST API to a strongly-typed GraphQL schema

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add hermeticormus/floreserlife api-design-principles

For use in Claude.ai and ChatGPT

Download Skill