rest-patterns

Codify RESTful API patterns for HTTP methods, status codes, caching, and rate limiting.

29|6|Updated Nov 27, 2025
One-click install
npx skills add https://github.com/0xDarkMatter/claude-mods --skill rest-patterns
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: rest-patterns
Source: https://github.com/0xDarkMatter/claude-mods/tree/main/skills/rest-patterns
Command: npx skills add https://github.com/0xDarkMatter/claude-mods --skill rest-patterns

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill provides instant access to RESTful API design patterns, HTTP semantics, and best practices for building scalable web services.

Frequently Asked Questions about rest-patterns

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I design REST API endpoints that follow HTTP method semantics?

REST API design uses HTTP methods (GET, POST, PUT, PATCH, DELETE) with specific semantics: GET retrieves data idempotently, POST creates resources, PUT replaces entire resources idempotently, PATCH updates partial resources, DELETE removes resources. Enforcing correct method usage ensures predictable, cacheable, and safe API behavior across clients.

What are the right HTTP status codes to return for different API responses?

HTTP status codes standardize API responses: 2xx indicates success, 3xx redirects, 4xx signals client errors (400 bad request, 404 not found, 409 conflict), 5xx indicates server errors. Consistent status code usage helps clients handle responses correctly and improves API debuggability.

How do I implement caching and rate limiting in REST APIs?

REST APIs use HTTP caching headers (Cache-Control, ETag, Last-Modified) to reduce server load and improve response times. Rate limiting enforces request quotas per client using headers or tokens, preventing abuse and ensuring fair resource allocation across users.

What's the best way to version REST APIs and handle breaking changes?

REST API versioning strategies include URL path versioning (v1/, v2/), header-based versioning, or query parameters. Versioning allows you to introduce breaking changes while maintaining backward compatibility, letting old clients continue working while new clients adopt improved endpoints.

How do I structure error responses and pagination in REST APIs?

Standardized error responses include consistent fields (error code, message, details), enabling clients to parse and handle failures predictably. Pagination using limit, offset, or cursor parameters lets clients retrieve large datasets incrementally without overloading the server.

Does REST API design support HATEOAS and hypermedia responses?

HATEOAS (Hypermedia As The Engine Of Application State) embeds links in API responses, allowing clients to discover related resources and actions dynamically. This approach decouples clients from hardcoded endpoint URLs and enables more flexible, self-documenting APIs.