Can this skill help with API documentation?

Yes, by enforcing consistent naming conventions, status codes, and resource hierarchies, it ensures that generated documentation is intuitive and professional.

Is it compatible with specific frameworks like FastAPI or Apollo?

While framework-agnostic in principle, it includes implementation examples for popular tools like FastAPI and Ariadne to demonstrate practical application.

Does it help with API versioning?

Yes, it covers multiple versioning strategies including URL, header, and query parameter versioning to ensure long-term API maintainability.

Can I use this to fix N+1 performance issues?

Absolutely. The skill includes specific patterns for DataLoader implementation in GraphQL to batch requests and optimize backend performance.

Does this skill support both REST and GraphQL?

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

API Design Principles

Name: API Design Principles
Author: HermeticOrmus

byHermeticOrmus

0•

API Development

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

The API Design Principles skill provides Claude with deep expertise in architecting professional-grade interfaces for both RESTful and GraphQL architectures. It guides the development of resource-oriented endpoints, schema-first GraphQL types, and robust versioning strategies to ensure long-term maintainability. By implementing advanced patterns like HATEOAS, standardized error handling, and DataLoader for N+1 prevention, this skill helps developers create APIs that are not only performant but also provide a delightful experience for third-party consumers and internal teams alike.

Key Features

01Resource-oriented RESTful architecture and HTTP method semantics

02Comprehensive error handling and HTTP status code standardization

03Advanced pagination and filtering patterns for large datasets

04Performance optimization techniques including N+1 query prevention

05Schema-first GraphQL design with strongly typed queries and mutations

060 GitHub stars

Use Cases

01Refactoring legacy endpoints to improve developer experience and consistency

02Establishing organizational API standards and reviewing specifications before implementation

03Architecting a new REST or GraphQL API from the ground up

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add hermeticormus/alqvimia-contador api-design-principles

For use in Claude.ai and ChatGPT

Download Skill