moai-ref-api-patterns

Standard REST API patterns apply consistent conventions for resource naming, versioning, pagination, and HTTP status codes across endpoints. This reference provides structured guidelines to align teams and accelerate backend service implementation.

Design error handling conventions using structured JSON errors, specific codes, and standardized response schemas. This approach improves client reliability by ensuring clear, consistent error responses across all REST and GraphQL API endpoints.

Yes, this reference supports both REST and GraphQL API design. You can use it to audit endpoint design proposals, enforce production-grade patterns, and apply standardized conventions during implementation reviews for either protocol.

Enforce input validation and secure defaults by applying specific guidelines for safe data handling. This ensures robust validation strategies are implemented across APIs, protecting backend services from invalid or malicious inputs.

The best way to scaffold a new backend API is to examine your design proposal and apply standardized REST or GraphQL conventions to the first endpoint. This ensures consistent resource naming, versioning, and error formats from the start.