What does the API Design skill do?

It provides Claude with a structured set of best practices and implementation patterns for creating consistent, scalable, and developer-friendly REST APIs.

How does it handle API pagination?

The skill provides patterns for both simple offset-based pagination (ideal for small datasets) and cursor-based pagination (optimized for large datasets and infinite scrolling).

What URL conventions does it follow?

It enforces resource-oriented design using plural nouns, lowercase paths, and kebab-case for multi-word resources, avoiding verbs in URLs.

Does it support multiple programming languages?

Yes, it includes implementation examples for popular frameworks in TypeScript (Next.js), Python (Django REST Framework), and Go.

REST API Design Patterns

Name: REST API Design Patterns
Author: lyxjack

bylyxjack

•

API Development

Standardizes REST API development with best practices for resource naming, status codes, pagination, and versioning.

The API Design Patterns skill provides Claude with a rigorous framework for building production-grade REST APIs. It establishes clear conventions for resource-oriented URL structures, semantic HTTP method usage, and robust error handling frameworks. By implementing this skill, developers can ensure their APIs support advanced features like cursor-based pagination, complex query filtering, and multi-layered rate limiting, while maintaining consistency across different tech stacks including TypeScript, Python, and Go. It is particularly useful for teams looking to standardize their API contracts and improve the developer experience for API consumers.

Key Features

01Semantic HTTP status code mapping for success and error states

02Implementation examples for TypeScript, Python (DRF), and Go

03Dual pagination strategies: Offset-based for UI and Cursor-based for scale

041 GitHub stars

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

06Comprehensive filtering, sorting, and sparse fieldset patterns

Use Cases

01Refactoring inconsistent API contracts to meet industry standards

02Implementing robust error handling and validation responses

03Designing new RESTful API endpoints and resource hierarchies

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add lyxjack/toolbox api-design

For use in Claude.ai and ChatGPT