Resource naming follows REST conventions
Why it matters
Verb-in-URL anti-patterns like /api/getUsers or /api/createPost conflate the resource with the action, which belongs to the HTTP method. This makes APIs harder to understand, breaks REST tooling that assumes noun-based paths, and forces every new developer to learn an idiosyncratic convention rather than standard REST. iso-25010:2011 maintainability.modifiability degrades measurably: adding a new operation on a resource requires inventing a new verb path rather than adding an HTTP method to an existing noun endpoint.
Severity rationale
High because inconsistent resource naming breaks REST tooling assumptions, makes APIs unintuitive for every new consumer, and compounds with each added endpoint.
Remediation
Rename all verb-in-URL routes to noun-based equivalents and let the HTTP method carry the action. Update your src/routes/ files:
// Before -- verbs in URLs:
GET /api/getUsers
POST /api/createPost
GET /api/user/1/getComments
// After -- nouns with HTTP method semantics:
GET /api/users
POST /api/posts
GET /api/users/1/comments
DELETE /api/posts/42
For actions that don't map to CRUD (e.g., send invoice, approve request), use a sub-resource pattern: POST /api/invoices/42/send.
DetectionPro
The detection method for this pattern is part of AuditBuffet Pro.
The full method (what to look for, pass and fail conditions, and how results get reported) ships inside the API Design Audit. The pattern definition, severity rationale, and remediation remain openly licensed under CC-BY-4.0.
External references
- iso-25010:2011 · maintainability.modifiability — Modifiability — consistent naming reduces change cost
Taxons
History
- 2026-04-18·v1.0.0·Initial import from api-design·automated