8471 shaares
203 private links
203 private links
- Be consistent
- Use ISO 8601 UTC dates
- Make an exception for public endpoints instead of
- Provide a health check endpoint:
GET /health - Version the API
- Accept API key authentication
- Use reasonable HTTP status codes
- Use reasonable HTTP methods
- Use self-explanatory, simple names: Most endpoints are resource-oriented and should be named that way.
- Use standardized error responses (the same error structure)
- Return created resources upon
POST - Prefer PATH over PUT: full update of a resource is rare
- Be as specific as possible
- Use pagination
- Allow expanding resources
