api-design-principles

Guide REST and GraphQL API design with versioning, error handling, and pagination patterns.

1|Updated Apr 21, 2025

Search Tags:#versioning #error handling #GraphQL #REST #API design #pagination #HATEOAS

One-click install

npx skills add https://github.com/agi-house-india/agihouse-site --skill api-design-principles-agi-house-india

Or copy as Structured Prompt for Agent▼

Please help me install this Agent Skill.
Skill: api-design-principles
Source: https://github.com/agi-house-india/agihouse-site/tree/main/.claude/skills/api-design-principles
Command: npx skills add https://github.com/agi-house-india/agihouse-site --skill api-design-principles-agi-house-india

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) and assets (resource) components.

What problem does it solve?

This Skill guides building intuitive REST and GraphQL APIs, establishing standard patterns for resources, versioning, error handling, pagination, and developer experience.

Core Features & Use Cases

RESTful Design Principles: Resource-oriented endpoints, proper HTTP methods, and consistent naming.
GraphQL Design Principles: Schema-first development, typed schemas, and real-time considerations.
API Versioning & Reliability: Versioning strategies, backward compatibility, and deprecation paths.
Error Handling & HATEOAS: Structured errors and hypermedia controls for discoverability.
Use Case: Design a new API with clear resource boundaries, a predictable versioning strategy, consistent error responses, and a GraphQL path for flexible queries.

Quick Start

Review the REST & GraphQL patterns and templates in the provided references and templates to start shaping your API definitions.