Can I use this for reviewing existing APIs?

Absolutely. This skill is designed to assist in reviewing existing API contracts to identify inconsistencies in naming, status codes, or response formats.

When should I use cursor-based pagination over offset-based?

The skill recommends cursor-based pagination for infinite scrolls, feeds, and large datasets where performance and stability during concurrent inserts are required.

Does it support different programming languages?

Yes, the skill includes specific implementation examples for popular frameworks like Next.js (TypeScript), Django (Python), and Go.

How does this skill help with API versioning?

It provides a clear strategy for URL path versioning, including guidance on sunsetting old endpoints and distinguishing between breaking and non-breaking changes.

REST API Design Patterns

Name: REST API Design Patterns
Author: Shawn-Guo-CN

byShawn-Guo-CN

0•

API 开发

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

This skill provides a comprehensive framework for architecting developer-friendly and consistent REST APIs using industry best practices. It guides Claude through the entire API lifecycle, from defining resource-oriented URL structures and semantic HTTP status codes to implementing advanced features like cursor-based pagination, rate limiting, and versioning strategies. It is an essential tool for backend engineers building new microservices, refactoring legacy endpoints, or designing public-facing developer platforms where consistency and predictability are critical for adoption.

主要功能

010 GitHub stars

02Standardized resource naming and URL structure conventions

03Semantic HTTP method and status code implementation guides

04Unified error response formatting and validation patterns

05Comprehensive API versioning and rate limiting strategies

06Scalable pagination strategies including Offset and Cursor-based methods

使用场景

01Refactoring internal endpoints for a public-facing developer platform

02Implementing standardized error handling and validation across a backend

03Designing a new microservice API from scratch with consistent naming

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add shawn-guo-cn/agentfoundry-plugin-marketplace api-design

For use in Claude.ai and ChatGPT

Download Skill