What API styles does this skill cover?

This skill specifically focuses on REST (Representational State Transfer) architecture, covering resource-based routing and HTTP method semantics.

Does it provide language-specific examples?

Yes, it includes implementation patterns for popular frameworks including Next.js (TypeScript), Django REST Framework (Python), and net/http (Go).

How does it handle API versioning?

It recommends URL path versioning as a primary strategy and provides a roadmap for handling breaking changes and deprecation timelines.

Should I use Offset or Cursor pagination?

This skill helps you decide: use Offset for small datasets or admin dashboards, and Cursor-based pagination for infinite scrolls or high-concurrency datasets.

REST API Design Patterns

Name: REST API Design Patterns
Author: oabdelmaksoud

byoabdelmaksoud

0•

API 开发

Standardizes REST API architecture through consistent resource naming, status codes, and implementation patterns.

This skill provides a comprehensive framework for designing consistent, developer-friendly REST APIs based on industry best practices. It guides the creation of resource-oriented URL structures, correct HTTP method usage, and semantic status code implementation. Users can leverage this skill to implement complex API features such as cursor-based pagination, advanced filtering and sorting, standardized error responses, and robust versioning strategies across multiple languages including TypeScript, Python, and Go, ensuring high-quality, production-grade API development.

主要功能

01Semantic HTTP status code mapping for success and error states

02Comprehensive pagination strategies for both Offset and Cursor methods

03Standardized JSON response wrappers and error object structures

04Standardized URL naming conventions using plural nouns and kebab-case

050 GitHub stars

06API versioning, rate limiting, and security header best practices

使用场景

01Auditing and refactoring legacy API contracts for consistency and scalability

02Designing robust error handling and validation logic for backend services

03Architecting new RESTful API endpoints for public-facing or internal services

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add oabdelmaksoud/superclaw api-design

For use in Claude.ai and ChatGPT