How does it handle error responses?

It advocates for semantic HTTP status codes combined with a standardized error envelope that includes machine-readable codes, messages, and field-level validation details.

What resource naming convention does this skill follow?

It recommends using plural nouns in kebab-case (e.g., /api/v1/team-members) and avoiding verbs in URLs to maintain strict RESTful standards.

Can this skill help with API versioning?

Absolutely. It outlines strategies for URL path versioning (recommended) and header versioning, including deprecation timelines and sunsetting policies.

Which programming languages are covered in the implementation patterns?

The skill includes production-ready code examples and implementation patterns for TypeScript (Next.js), Python (Django REST Framework), and Go.

Does it support different pagination methods?

Yes, it provides patterns for both simple offset-based pagination for small datasets and scalable keyset-based (cursor) pagination for high-performance feeds.

API Design Patterns

Name: API Design Patterns
Author: flatrick

byflatrick

0•

API開発

Standardizes RESTful API architecture using production-grade patterns for resource naming, status codes, and scalable pagination.

The API Design Patterns skill provides comprehensive guidance for building developer-friendly, consistent, and scalable REST APIs. It enforces industry best practices for URL structure, semantic HTTP method usage, and robust error handling while offering implementation patterns across multiple languages like TypeScript, Python, and Go. Whether you are architecting a new public API or refining internal microservices, this skill ensures your endpoints follow standard conventions for filtering, sorting, versioning, and rate limiting to improve interoperability and the overall developer experience.

主な機能

01Versioning and rate-limiting strategies for maintaining long-term API stability

02Scalable pagination strategies including both offset-based and keyset/cursor-based approaches

030 GitHub stars

04Advanced query patterns for filtering, sorting, and full-text search

05Standardized resource naming and URL structure using kebab-case plural nouns

06Semantic HTTP status code mapping and consistent error response formatting

ユースケース

01Implementing standardized pagination and filtering for large datasets

02Establishing consistent error handling and authentication patterns across microservices

03Architecting a new production-grade REST API from scratch

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add flatrick/mdt api-design

For use in Claude.ai and ChatGPT