What is the difference between Offset and Keyset pagination in this skill?

Offset-based is recommended for small datasets and admin dashboards, while Keyset (cursor) pagination is suggested for high-performance infinite scrolls and large datasets.

How does this skill handle API versioning?

It recommends URL path versioning (e.g., /v1/) for explicitness and provides a strategy for maintaining active versions and handling deprecation via Sunset headers.

Does it provide code examples for specific frameworks?

Yes, it includes implementation patterns for Next.js (TypeScript), Django REST Framework (Python), and Go's net/http package.

What are the recommended naming conventions?

The skill enforces using plural nouns, lowercase letters, and kebab-case for resource paths, while avoiding verbs in the URL structure.

REST API Design Patterns

Name: REST API Design Patterns
Author: flatrick

byflatrick

0•

API 开发

Standardizes REST API architecture through production-grade patterns for resource naming, status codes, and pagination.

This skill equips Claude with a comprehensive framework for designing consistent, developer-friendly REST APIs. It provides detailed guidance on resource-oriented URL structures, semantic HTTP method usage, standardized error response envelopes, and advanced features like keyset pagination and rate limiting. Whether you are building a new public API or reviewing internal service contracts, this skill ensures your backend services follow industry best practices with implementation examples in TypeScript, Python, and Go.

主要功能

01Scalable pagination strategies including Offset and Keyset/Cursor patterns

02Resource-oriented URL and naming convention standardization

03Comprehensive HTTP status code and method semantic mapping

040 GitHub stars

05Proven versioning, filtering, and rate-limiting implementation guides

06Standardized JSON response envelopes for success and error states

使用场景

01Architecting a new public-facing REST API from scratch

02Standardizing error handling and response formats across microservices

03Implementing scalable pagination for high-volume datasets

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add flatrick/mdt api-design

For use in Claude.ai and ChatGPT