Does this skill provide language-specific examples?

Yes, it includes implementation patterns for modern frameworks including Next.js (TypeScript), Django REST Framework (Python), and Go (net/http).

Does it support both offset and cursor-based pagination?

Yes, it provides implementation patterns for both, helping you choose between simple page-based navigation and high-performance cursor-based scaling.

Can it help with error response formatting?

Absolutely. It defines a standardized JSON error envelope that includes machine-readable error codes, human-readable messages, and field-level validation details.

What API architectural style does this skill focus on?

This skill primarily focuses on RESTful API design principles, emphasizing resource-oriented architecture and standard HTTP methods.

API Design Patterns

Name: API Design Patterns
Author: lyxjack

bylyxjack

•

API Development

Standardizes REST API development with production-ready patterns for resource naming, error handling, and pagination.

This skill empowers Claude to act as a senior API architect, providing standardized guidance for building consistent and developer-friendly RESTful services. It covers essential architectural decisions including resource-based URL structures, semantic HTTP status code usage, advanced pagination strategies, and robust error response formatting. Whether you are designing a new public API from scratch or refining an internal service, this skill ensures your endpoints follow industry best practices for versioning, filtering, and rate limiting across various languages and frameworks.

Key Features

01Implementation guides for both Offset-based and Cursor-based pagination

02Advanced filtering, sorting, and sparse fieldset query patterns

03Standardized resource naming using plural nouns and kebab-case URLs

04Comprehensive API versioning strategies and rate limiting headers

05Semantic HTTP status code mapping for success, client, and server errors

061 GitHub stars

Use Cases

01Designing a new production-ready REST API from scratch

02Refactoring existing endpoints to follow industry best practices

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