HTTP API Design Guide
March 15, 2019 ยท View on GitHub
- Foundations
- Requests
- Responses
- Return appropriate status codes
- Provide full resources where available
- Provide resource (UU)IDs
- Provide standard timestamps
- Provide standard response types
- Use UTC times formatted in ISO8601
- Nest foreign key relations
- Generate structured errors
- Show rate limit status
- Keep JSON minified in all responses
- Artifacts