What problem does it solve?
Provides clear, consistent patterns for defining REST and GraphQL endpoints, pagination, filtering, versioning, authentication, error handling, and API documentation so teams can build interoperable, maintainable backend services.
Core Features & Use Cases
- Endpoint & Resource Conventions: Guidance on resource naming, nested resources, and when to use RPC-style actions.
- Pagination & Filtering Strategies: Offset and cursor pagination patterns with response shapes and pagination metadata recommendations.
- Versioning & Documentation: Recommendations for URL and header versioning and examples for OpenAPI/Swagger schemas.
- Error Handling & Best Practices: Standardized error formats, HTTP status code usage, idempotency, rate limiting, and HATEOAS link inclusion.
- Use Case: Designing user, order, or product APIs that require consistent responses, pagination, and OpenAPI documentation for client generation.
Quick Start
Design an API for a user management service with REST endpoints for CRUD, cursor pagination for lists, query filtering, bearer authentication, and an OpenAPI spec documenting each route.