api-design

You can audit API design consistency by scanning route handlers to detect deviations in HTTP verbs, URL structures, response shapes, and validation placement, outputting a remediation backlog to docs/refactoring-backlog.md.

An API design audit identifies inconsistent routing, error models, and pagination patterns across a backend codebase. You need it when inconsistent API conventions make maintenance and onboarding harder for your development team.

Checking HTTP verb alignment involves reading route handlers to verify GET, POST, PUT, and PATCH usage against project conventions, alongside validating URL resource modeling to ensure endpoint structures remain uniform and compliant.

Yes, you can generate a refactoring backlog by analyzing route handlers to find inconsistent error shapes and validation formatting, writing actionable remediation items directly into docs/refactoring-backlog.md for tracking.

Yes, the audit applies to backend projects with REST or RPC routes, reading existing route handlers and backlog files to detect deviations from your established project conventions rather than enforcing external standards.

Response shapes vary due to unchecked deviations in route handler implementations. An audit surfaces these inconsistencies alongside error model variations, proposing uniform improvements in a backlog-ready report for remediation.