What naming conventions does this skill prioritize?

The skill enforces the use of plural nouns and kebab-case for resource paths (e.g., /api/v1/user-profiles) to ensure URL consistency and readability.

Does it support cursor-based pagination?

Yes, it provides implementation patterns for both simple offset-based pagination for small datasets and high-performance cursor-based pagination for infinite scrolling and large datasets.

Can this skill help with input validation errors?

Absolutely. It includes patterns for returning 422 Unprocessable Entity or 400 Bad Request status codes accompanied by detailed error objects that specify which fields failed validation.

How does it handle API versioning?

It primarily recommends URL path versioning (e.g., /v1/, /v2/) for its explicitness and cacheability, while also providing guidance on sunsetting old versions.

REST API Design Patterns

Name: REST API Design Patterns
Author: Mark393295827

byMark393295827

•

API Development

Standardizes RESTful API development through consistent resource naming, semantic status codes, and scalable architectural patterns.

The API Design Patterns skill provides a comprehensive framework for building developer-friendly, production-grade REST APIs. It equips Claude with specialized knowledge to handle complex backend tasks, including implementing idempotent PATCH operations, structuring semantic error responses, and choosing between offset or cursor-based pagination. By adhering to industry-standard conventions like kebab-case URL structures and standardized response envelopes, this skill ensures that your API contracts remain consistent, maintainable, and easy for third-party developers to consume.

Key Features

011 GitHub stars

02Standardized resource naming using kebab-case and plural nouns

03Comprehensive mapping of semantic HTTP status codes for all CRUD operations

04Robust error response formatting with field-level validation details

05Advanced filtering, sorting, and sparse fieldset implementation strategies

06Scalable pagination patterns including both offset and cursor-based methods

Use Cases

01Implementing standardized rate limiting and versioning for public APIs

02Refactoring legacy API contracts to meet modern REST standards

03Designing new API endpoints for scalable microservices

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add mark393295827/house-maint-ai api-design

For use in Claude.ai and ChatGPT

Download Skill