---

name: rest-api description: REST API design principles and implementation patterns. Use when designing API endpoints, creating API clients, or implementing HTTP communication between frontend and backend. allowed-tools: Read, Edit, Write, Glob, Grep, Bash

REST API Skill

Quick Reference

REST (Representational State Transfer) is an architectural style for designing networked applications.

API Endpoints (Based on Spec)

HTTP Methods

• GET - Retrieve resources (safe, idempotent)
• POST - Create new resources (not idempotent)
• PUT - Update/replace entire resource (idempotent)
• PATCH - Partial update (not idempotent)
• DELETE - Remove resource (idempotent)

Status Codes

Request Format

Headers

CopyAuthorization: Bearer {JWT_TOKEN}
Content-Type: application/json
Accept: application/json

Body (POST/PUT/PATCH)

Copy{
  "title": "Buy groceries",
  "description": "Milk, eggs, bread",
  "completed": false
}

Response Format

Success (200/201)

Copy{
  "id": 1,
  "user_id": "user_123",
  "title": "Buy groceries",
  "description": "Milk, eggs, bread",
  "completed": false,
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}

Error (4xx/5xx)

Copy{
  "detail": "Task not found",
  "code": "NOT_FOUND"
}

For Detailed Reference

See REFERENCE.md for:

• Advanced query parameters
• Pagination patterns
• API versioning
• Rate limiting
• OpenAPI documentation