Will It Vibe logoWill It Vibe?
API-001Info severity-2 points

API has no URL versioning scheme

Part of Architecture & Best Practices, which counts for 15% of the overall score. When this check fires it deducts 2 points from that category, once per scan, no matter how many places it turns up.

What it detects

A project registers many /api/ routes but none of them contain a version segment such as /v1/, so there is no way to introduce a breaking change without risking every existing client. This is a heuristic: teams that version via an Accept header or a custom media type instead of the URL will not need this.

Why it matters

When an API has no version segment in its routes, there is no safe way to change a response shape or remove a field: every existing client is on the same unversioned surface, so any breaking change breaks everyone at once. Teams end up either never improving the contract or shipping breaking changes and finding out from angry integrators. A version prefix gives you a place to introduce v2 alongside v1 and migrate callers on their own schedule.

How to fix it

Add a version segment to the route prefix, typically /api/v1/..., and mount all current routes under it. When you need a breaking change, add /api/v2/... alongside v1 instead of changing v1 in place, and give existing integrators a deprecation window before removing the old version.

The paid report includes a ready-to-paste prompt for your AI coding agent for every check it finds, pointed at the exact findings from your scan. See pricing

Does your repo trip this check?

Paste a GitHub URL or drop a project folder. Scans run in your browser and take seconds.

Scan your repo

Related Architecture & Best Practices checks