How does it handle API versioning?

The framework recommends URI-based versioning (e.g., /api/v1/) as the most explicit and compatible strategy for public-facing and internal APIs.

Does it help with frontend integration?

Yes, it includes specialized patterns for runtime validation with Zod, request interceptors with ky, and integration with TanStack Query.

Does this skill support multiple protocols?

Yes, it provides specific design guidance for REST, GraphQL (including Connection patterns), and gRPC (including Proto definitions and status mapping).

What pagination methods are included?

It prioritizes cursor-based pagination for high-performance and stability under data changes, but also provides patterns for offset-based paging.

Which agent uses this skill most effectively?

While versatile, the backend-system-architect agent uses this skill as its primary framework for designing and reviewing API contracts.

API Design Framework

Name: API Design Framework
Author: yonatangross

byyonatangross

•

API 개발

Architects robust, scalable APIs using industry-standard patterns for REST, GraphQL, and gRPC services.

소개

The API Design Framework skill empowers developers to build production-ready interfaces by providing a comprehensive set of conventions and architectural best practices. It covers the entire lifecycle of API development, from resource naming and protocol selection to advanced features like cursor-based pagination, structured error handling, and Zod-based frontend validation. By enforcing consistency and developer-centric design, this skill ensures that backend systems remain maintainable, scalable, and intuitive for third-party consumers and internal teams alike.

주요 기능

Scalable pagination strategies including cursor-based and offset navigation
Multi-protocol support for REST, GraphQL, and gRPC architectures
Comprehensive versioning, rate-limiting, and authentication implementation guides
29 GitHub stars
Standardized error response formats with request tracking and debugging details
Integrated frontend validation patterns using Zod and TanStack Query

사용 사례

Designing a new RESTful microservice from scratch with consistent naming conventions
Implementing type-safe frontend-to-backend communication with runtime validation
Migrating legacy APIs to a modern versioned structure without breaking changes

소개

주요 기능

Scalable pagination strategies including cursor-based and offset navigation
Multi-protocol support for REST, GraphQL, and gRPC architectures
Comprehensive versioning, rate-limiting, and authentication implementation guides
29 GitHub stars
Standardized error response formats with request tracking and debugging details
Integrated frontend validation patterns using Zod and TanStack Query

사용 사례

Designing a new RESTful microservice from scratch with consistent naming conventions
Implementing type-safe frontend-to-backend communication with runtime validation
Migrating legacy APIs to a modern versioned structure without breaking changes