Section: Anti-patterns

Avoid deeply nested routes

text
text
Avoid: /orgs/{orgId}/teams/{teamId}/projects/{projectId}/tickets/{ticketId}/comments
Explanation

Very deep routes make identity, authorization, and caching rules harder to reason about.

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 Anti-patterns
Verbs in CRUD endpoints
Avoid route names that duplicate the HTTP method.
OpenIn sheettextsame section
Do not return 200 for every outcome
Use HTTP status codes meaningfully.
OpenIn sheettextsame section
Do not expose raw database internals
Keep API models stable and intentional.
OpenIn sheettextsame section
Do not ship breaking changes silently
Version or phase in incompatible changes.
OpenIn sheettextsame section
Keep response contracts consistent
Use the same top-level response structure across endpoints.
OpenIn sheettext1 tag match
Return a request ID
Make support and debugging easier.
OpenIn sheethttp1 tag match