Keep URLs maintainable.
Section: Anti-patterns
Avoid deeply nested routes
text
text
Avoid: /orgs/{orgId}/teams/{teamId}/projects/{projectId}/tickets/{ticketId}/commentsExplanation
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.
Do not expose raw database internals
Keep API models stable and intentional.
Do not ship breaking changes silently
Version or phase in incompatible changes.
Keep response contracts consistent
Use the same top-level response structure across endpoints.