How does this skill help with API consistency?

It provides a strict set of naming conventions (kebab-case, plural nouns) and semantic status code mappings to ensure every endpoint behaves predictably for developers.

How does it handle API versioning?

The skill recommends URL path versioning (v1, v2) and provides a strategy for deprecation timelines and handling non-breaking changes.

Does it include security best practices?

Yes, it covers token-based authentication (Bearer/API Key), resource-level authorization patterns, and rate-limiting implementation.

Does it support multiple programming languages?

Yes, it includes specific implementation patterns and code snippets for TypeScript (Next.js), Python (Django REST Framework), and Go.

What pagination methods are covered?

It details both Offset-based pagination for simple use cases and Cursor-based pagination for high-performance, large datasets and infinite scrolling.

REST API Design Patterns

Name: REST API Design Patterns
Author: oabdelmaksoud

byoabdelmaksoud

0•

API 开发

Standardizes RESTful API development through proven design patterns, resource naming conventions, and robust implementation strategies.

This skill provides a comprehensive framework for designing consistent, developer-friendly REST APIs based on Enterprise Cloud Computing (ECC) standards. It guides Claude through best practices for resource naming, semantic HTTP method usage, and standardized status codes to ensure clear communication between client and server. The skill also covers advanced implementation details including cursor-based pagination for scalability, complex filtering mechanisms, robust error response structures, and API versioning strategies across multiple environments like TypeScript, Python, and Go.

主要功能

01Standardized URL structures using plural nouns and kebab-case naming

020 GitHub stars

03Semantic HTTP method mapping and status code reference for consistent responses

04Comprehensive error handling patterns with field-level validation details

05Dual pagination strategies covering both Offset and Cursor-based implementations

06Detailed versioning and rate-limiting strategies for production-grade APIs

使用场景

01Architecting new RESTful API endpoints with industry-standard naming and structure

02Implementing advanced data features like sparse fieldsets, complex filtering, and sorting

03Refactoring existing API contracts to improve developer experience and consistency

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add oabdelmaksoud/agention api-design

For use in Claude.ai and ChatGPT