skills.rest
hydershah
hydershahCOMMUNITY
Explore all skills by this author →
GitHub

api-design

Guide RESTful API design with response formats, status codes, and versioning.

Updated Dec 30, 2025
Search Tags:#versioning#authentication#rest#http#error-handling#pagination#api-design
Ready to run
npx skills add https://github.com/hydershah/advance-appliance --skill api-design-hydershah
💬 Prompt for ChatGPT / Claude Chat▼
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/hydershah/advance-appliance/tree/main/.claude/skills/api-design
Command: npx skills add https://github.com/hydershah/advance-appliance --skill api-design-hydershah

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill guides RESTful API design, including clear response formats, status codes, pagination, filtering, and versioning, to improve backend APIs.

Core Features & Use Cases

  • REST Conventions with HTTP methods and idempotence
  • URL Structure & Versioning for stable APIs
  • Response Format with data and meta
  • Error Handling with structured error payloads
  • Pagination, Filtering & Sorting for client-friendly queries
  • Authentication using JWT or API keys
  • Versioning strategies and bucketed changes
  • Rate Limiting Headers for visibility

Quick Start

Design an endpoint GET /api/v1/users with a paginated list and proper error responses.