How does it handle API versioning?

It primarily recommends URL path versioning (e.g., /v1/) for explicit routing and maintainability, while also discussing the pros and cons of header-based versioning.

What authentication patterns are covered?

The skill provides patterns for token-based authentication (Bearer/JWT), API keys for server-to-server communication, and role-based access control (RBAC).

Which pagination method is recommended by this skill?

The skill covers both offset-based pagination for small datasets and cursor-based pagination for high-scale, infinite scroll applications or large feeds.

Does it include guidance on error handling?

Yes, it defines a standardized error envelope that includes unique error codes, descriptive messages, and field-level validation details for a better developer experience.

Does this skill support specific programming languages?

Yes, the skill provides implementation patterns and code examples for TypeScript (Next.js), Python (Django REST Framework), and Go.

REST API Design Patterns

Name: REST API Design Patterns
Author: lyxjack

bylyxjack

•

API 개발

Implements standardized RESTful API architecture following industry best practices for consistency, scalability, and developer experience.

This skill equips Claude with a comprehensive framework for designing production-grade REST APIs. It provides deep guidance on resource naming conventions, semantic HTTP status code usage, and complex patterns like cursor-based pagination and nested filtering. By following these established patterns, developers can ensure their APIs are intuitive, well-documented, and robust enough to handle high-scale production environments across various languages including TypeScript, Python, and Go.

주요 기능

01Semantic HTTP method and status code mapping

02Advanced pagination strategies including offset and cursor-based methods

031 GitHub stars

04Standardized resource naming and URL structure conventions

05API versioning and rate limiting implementation patterns

06Robust error handling and response envelope structures

사용 사례

01Standardizing existing API contracts across a microservices architecture

02Architecting a new public-facing REST API from scratch

03Implementing scalable pagination and filtering for large datasets

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add lyxjack/toolbox api-design

For use in Claude.ai and ChatGPT