What versioning strategies are included?

It covers URL versioning, Header versioning, and Query Parameter versioning to help you manage API lifecycles effectively.

How does it handle GraphQL performance issues?

The skill provides specific implementation patterns for N+1 problem prevention using DataLoaders and optimized resolver design.

Does this skill support both REST and GraphQL?

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

Can I use this for existing API refactoring?

Absolutely. It includes patterns for refactoring action-oriented endpoints into resource-oriented ones and improving overall API usability.

API Design Principles

Name: API Design Principles
Author: amurata

byamurata

•

API 开发

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

关于

This skill empowers developers to build high-quality backend interfaces by providing comprehensive guidance on both RESTful and GraphQL design paradigms. It covers essential concepts such as resource-oriented architecture, schema-first development, and consistent versioning strategies. With detailed implementation patterns for pagination, robust error handling, and N+1 problem prevention via DataLoaders, this skill ensures your APIs are developer-friendly, performant, and capable of evolving over time. It is an ideal companion for designing new services, refactoring legacy endpoints, or establishing organizational API standards.

主要功能

Advanced patterns for pagination, filtering, and HATEOAS
Robust error handling and HTTP status code mapping
Standardized RESTful resource-oriented architecture patterns
Comprehensive API versioning and lifecycle strategies
GraphQL schema-first design and query optimization
3 GitHub stars

使用场景

Refactoring existing endpoints to improve developer experience and usability
Designing a new greenfield REST or GraphQL API from scratch
Establishing a consistent API style guide for cross-team development

关于

主要功能

Advanced patterns for pagination, filtering, and HATEOAS
Robust error handling and HTTP status code mapping
Standardized RESTful resource-oriented architecture patterns
Comprehensive API versioning and lifecycle strategies
GraphQL schema-first design and query optimization
3 GitHub stars

使用场景

Refactoring existing endpoints to improve developer experience and usability
Designing a new greenfield REST or GraphQL API from scratch
Establishing a consistent API style guide for cross-team development