0122-api-design-principles

What problem does it solve?

API teams often ship interfaces that are inconsistent, hard to use, painful to version, and inefficient for clients, causing ongoing refactors and developer frustration.

Core Features & Use Cases

• REST API design foundations: resource-oriented endpoints, correct HTTP method semantics, and pragmatic patterns for collections, pagination, and filtering.
• GraphQL API design fundamentals: schema-first modeling, query/mutation structure, and relationship performance patterns to avoid N+1 problems.
• Operational readiness guidance: consistent error handling, versioning strategies, and a shared checklist for security, documentation, testing, and monitoring.
• Use cases: applying these principles when designing a new API, reviewing an existing OpenAPI/GraphQL spec, or standardizing team-wide API conventions.

Quick Start

Ask the AI to review your planned REST and GraphQL endpoints against the checklist and return concrete fixes for resource naming, HTTP semantics, pagination, error format, and versioning.