Does this skill support both REST and GraphQL?

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

Is this skill useful for documenting existing APIs?

Yes, it provides guidelines for creating developer-friendly documentation, including HATEOAS-compliant responses and clear resource hierarchies.

Can it help with API performance issues?

Absolutely. It includes patterns for N+1 query prevention using DataLoaders and efficient pagination strategies for large datasets.

How does it help with API consistency?

It establishes clear standards for naming conventions, HTTP status codes, and error response structures to ensure a uniform developer experience.

API Design Principles

Name: API Design Principles
Author: Microck

byMicrock

•

138

•

API 开发

Standardizes REST and GraphQL API architecture through best practices in resource modeling, schema design, and developer experience.

This skill provides comprehensive guidance for designing scalable, maintainable, and intuitive APIs using both REST and GraphQL paradigms. It enables Claude to assist with resource-oriented architecture, schema-first development, efficient pagination, consistent error handling, and performance optimization techniques like DataLoader. Whether building new endpoints, refactoring existing ones, or establishing team-wide standards, this skill ensures your APIs are developer-friendly, performant, and built to stand the test of time.

主要功能

01Schema-first GraphQL design and type definitions

02Resource-oriented RESTful architecture patterns

03138 GitHub stars

04Performance optimization including N+1 prevention with DataLoader

05Scalable pagination and HATEOAS implementation strategies

06Standardized error handling and HTTP status code mapping

使用场景

01Migrating services from REST to GraphQL or implementing hybrid architectures

02Refactoring legacy API endpoints for better usability and consistency

03Designing new REST or GraphQL API specifications from scratch

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add microck/ordinary-claude-skills api-design-principles

For use in Claude.ai and ChatGPT

Download Skill