rest-api-design-and-errors
CommunityEnforce consistent REST API design across stacks.
Software Engineering#design-principles#error-handling#pagination#rest-api#api-contracts#problem-details
Authormub7865
Version1.0.0
Installs0
System Documentation
What problem does it solve?
Consistent REST API design reduces integration friction by standardizing resource naming, URL structure, HTTP methods, pagination, filtering, sorting, and error responses across services.
Core Features & Use Cases
- Resource naming rules enforce plural collections and nested patterns (e.g., /users, /users/{id}, /projects/{project_id}/tasks).
- Standardized pagination, filtering, and sorting mechanisms (page, page_size, filter, sort) across endpoints.
- Centralized error formatting using Problem Details (application/problem+json) with consistent status codes and error fields.
Quick Start
Provide a canonical REST API contract for a new project using the /api/v1 pattern with proper resource naming, pagination, and RFC 7807 Problem Details error handling.
Dependency Matrix
Required Modules
None requiredComponents
Standard package💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: rest-api-design-and-errors Download link: https://github.com/mub7865/Hackathone-2/archive/main.zip#rest-api-design-and-errors Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.