Does this skill support both REST and GraphQL?

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

Can it help with existing API refactoring?

Absolutely. The skill includes best practices for identifying action-oriented anti-patterns and migrating legacy endpoints to more intuitive, resource-oriented structures.

How does it handle performance issues like the N+1 problem?

It provides specific patterns like DataLoader for GraphQL and optimized batching strategies to ensure efficient data fetching and backend performance.

Does it include error handling standards?

Yes, it establishes consistent error response structures and ensures the correct use of HTTP status codes for both success and failure scenarios.

API Design Principles

Name: API Design Principles
Author: HermeticOrmus

byHermeticOrmus

0•

API Development

Designs and refactors intuitive, scalable REST and GraphQL APIs using industry-standard patterns and best practices.

This skill empowers Claude to architect high-quality backend interfaces by applying deep expertise in RESTful architecture and GraphQL schema-first design. It provides comprehensive patterns for resource management, versioning, pagination, and error handling, ensuring APIs are not only functional but also developer-friendly and maintainable. Whether you are starting a new project, migrating paradigms, or reviewing existing specifications, this skill helps establish robust API standards and prevents common pitfalls like the N+1 problem through advanced implementation patterns like DataLoader.

Key Features

01GraphQL schema-first development and resolver optimization

02Standardized error handling and HTTP status code mapping

03Scalable pagination, filtering, and HATEOAS implementation

04Robust API versioning strategies for long-term maintenance

050 GitHub stars

06RESTful resource-oriented architecture and HTTP method semantics

Use Cases

01Designing a new REST or GraphQL API from scratch with consistent standards

02Refactoring legacy API endpoints to improve usability and follow modern best practices

03Reviewing API specifications to ensure performance, security, and developer experience

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add hermeticormus/hermetic-academy api-design-principles

For use in Claude.ai and ChatGPT

Download Skill