api-architecture

Community

Standardize REST APIs with robust data patterns.

AuthorSimyV
Version1.0.0
Installs0

System Documentation

What problem does it solve?

REST API design often suffers from inconsistent endpoints, error handling, and data-fetch patterns across frontend and backend teams. This Skill provides standardized conventions and practical layouts to align API routes, response formats, and React Query usage for robust, scalable apps.

Core Features & Use Cases

  • RESTful Endpoint Design: Resource-based URLs with consistent naming, clear nesting limits, and actions for non-CRUD operations.
  • Standardized Error Handling & Validation: Centralized error classes and validation helpers that produce uniform, machine-readable error responses.
  • Structured Folder/Layout Guidance: Recommended API folder structure (api/, services/, repositories/, hooks/, lib/) and clear separation of concerns to reduce coupling.
  • React Query Integration: Prescribed query/mutation patterns, caching strategies, and common hooks to streamline data fetching in frontend apps.
  • Use Case: When building a new backend service and its frontend, apply these patterns to spin up a consistent API surface quickly.

Quick Start

Create a minimal /api/users resource with list and detail endpoints, plus a basic error model and a React Query hook.

Dependency Matrix

Required Modules

None required

Components

references

💻 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: api-architecture
Download link: https://github.com/SimyV/agent-system/archive/main.zip#api-architecture

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.