What is the advantage of using RFC 7807 for errors?

RFC 7807 provides a standardized, machine-readable format for error responses, making it easier for clients to handle specific error types consistently across different endpoints.

Is this skill tied to a specific framework like Express or NestJS?

No, the principles and implementation patterns are framework-agnostic and can be applied to any TypeScript backend environment, including Fastify, Express, or Hono.

How should I handle API versioning using this skill?

The skill recommends versioning in the URL path (e.g., /api/v1/) to ensure the API remains easy to test, debug, and cache compared to header-based or query-param versioning.

Why does this skill recommend cursor-based pagination over offset?

Cursor-based pagination is more performant for large datasets and remains stable even when records are inserted or deleted, avoiding the 'skipping' or 'duplication' issues common with offset-based pagination.

TypeScript API Design Patterns

Name: TypeScript API Design Patterns
Author: martinffx

bymartinffx

•

API開発

Implements standardized REST API design patterns and best practices for consistent, maintainable TypeScript backend services.

This skill provides a comprehensive blueprint for architecting high-quality REST APIs using TypeScript. It streamlines the development process by providing opinionated yet framework-agnostic guidance on resource naming conventions, URL-based versioning, and robust error handling through RFC 7807 Problem Details. Developers can leverage advanced patterns like cursor-based pagination for high-performance data fetching, idempotency keys for safe retries, and standardized filtering/sorting logic. Whether you are bootstrapping a new service or refactoring an existing one, this skill ensures your API remains scalable, predictable, and easy for clients to consume.

主な機能

01Efficient cursor-based pagination implementations

02Idempotency key patterns for safe POST/PATCH operations

03Predictable RESTful resource naming and nesting patterns

04URL-based API versioning strategies

05Standardized RFC 7807 error response structures

066 GitHub stars

ユースケース

01Designing a new RESTful microservice from scratch with consistent patterns

02Implementing scalable pagination for applications with large datasets

03Refactoring legacy API error handling to meet modern web standards

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add martinffx/claude-code-atelier atelier-typescript-api-design

For use in Claude.ai and ChatGPT

Download Skill