How is the project structure organized?

It follows a 'one file per route' philosophy with co-located tests, ensuring that as your API grows, the codebase remains navigable and maintainable.

How does it handle dependency injection?

It utilizes a Route Factory Pattern where handlers are created via functions that accept dependencies as arguments, allowing for easy mocking and unit testing without global state.

What frameworks does this skill support?

This skill primarily focuses on patterns compatible with @orpc/server and Zod, but the architectural principles regarding thin handlers and dependency injection can be adapted to most TypeScript backend frameworks.

Is error handling standardized?

Absolutely. The skill enforces a consistent JSON error envelope with machine-readable codes, human-readable messages, and correlation IDs (X-Request-ID) for efficient debugging.

Does it include health checks?

Yes, it provides specific implementation patterns for /health (liveness) and /ready (readiness) endpoints to ensure proper traffic routing in containerized environments.

Production-Ready API Design

Name: Production-Ready API Design
Author: jagreehal

byjagreehal

Desarrollo de API

Builds robust, production-grade HTTP APIs using clean handlers, consistent error envelopes, and operational best practices.

Acerca de

The api-design skill provides Claude with the architectural blueprints and implementation patterns required to build high-quality HTTP APIs. It emphasizes the 'thin handler' principle, separating HTTP concerns from domain logic through dependency injection and route factories. By enforcing standardized error envelopes, health check endpoints, idempotency for mutations, and graceful shutdown procedures, this skill ensures that backend services are not only functional but also operationally excellent and maintainable at scale.

Características Principales

Enforces consistent JSON error envelopes and standard HTTP status mapping
Adds support for idempotency keys and rate limiting with Retry-After headers
Implements the Route Factory Pattern with dependency injection for testable handlers
Configures operational essentials like health/readiness checks and graceful shutdown
Provides a standardized file organization structure for scalable API routes
0 GitHub stars

Casos de Uso

Standardizing error handling and operational monitoring across backend microservices
Bootstrapping a new TypeScript-based REST or RPC API with @orpc/server
Refactoring messy controller logic into clean, testable handlers

Acerca de

Características Principales

Enforces consistent JSON error envelopes and standard HTTP status mapping
Adds support for idempotency keys and rate limiting with Retry-After headers
Implements the Route Factory Pattern with dependency injection for testable handlers
Configures operational essentials like health/readiness checks and graceful shutdown
Provides a standardized file organization structure for scalable API routes
0 GitHub stars

Casos de Uso

Standardizing error handling and operational monitoring across backend microservices
Bootstrapping a new TypeScript-based REST or RPC API with @orpc/server
Refactoring messy controller logic into clean, testable handlers