REST API Best Practices and Anti-Patterns/Document rate limits clearly

Help clients back off safely.

Section: Best practices

Document rate limits clearly

http
http
RateLimit-Limit: 100
RateLimit-Remaining: 24
RateLimit-Reset: 60
Explanation

Returning limit metadata helps clients self-throttle and debug rate-limit behavior.

Learn the surrounding workflow

Compare similar commands or jump into common fixes when this command is part of a bigger troubleshooting path.

Related commands

Same sheet · prioritizing Best practices
Keep response contracts consistent
Use the same top-level response structure across endpoints.
OpenIn sheettextsame section
Return a request ID
Make support and debugging easier.
OpenIn sheethttpsame section
Use ISO 8601 timestamps
Prefer explicit timezone-aware datetime strings.
OpenIn sheettextsame section
Provide copy-paste examples
Show real requests and responses in docs.
OpenIn sheetbashsame section
Verbs in CRUD endpoints
Avoid route names that duplicate the HTTP method.
OpenIn sheettext1 tag match
Do not return 200 for every outcome
Use HTTP status codes meaningfully.
OpenIn sheettext1 tag match