0122-api-design-principles

Design REST API endpoints using resource-oriented semantics, correct HTTP methods, and pragmatic patterns for collections, filtering, and pagination to ensure consistent structure and clear client contracts.

Avoid N+1 query problems in GraphQL API design by applying schema-first modeling and relationship performance patterns to optimize query and mutation structures for efficient data fetching.

Implement standardized error handling and versioning for production APIs by applying consistent error response formats, standardized status codes, and strategic versioning patterns to ensure operational readiness.

Yes, you can review existing OpenAPI or GraphQL specifications by checking them against operational readiness checklists for security, documentation, testing, and monitoring to return concrete fixes.

API design guidance covers both REST and GraphQL pagination strategies, providing pragmatic patterns for REST collections and relationship performance patterns for GraphQL to ensure efficient client interactions.

Standardize team-wide API conventions for developer experience when designing new APIs, reviewing specifications, or selecting operational strategies to prevent painful refactors and developer frustration.