Api Versioning (ARCH3202)

Key typescript.quality.api-versioning · Severity info · Category quality

Controllers without an explicit API version make it impossible to ship backward-incompatible changes without breaking existing clients. The version should be stated explicitly via the route path or an attribute.

Incorrect

@Controller("users")
export class UsersController {
  @Get() list() { return this.svc.all(); }
}

Correct

@Controller({ path: "users", version: "1" })
export class UsersController {
  @Get() list() { return this.svc.all(); }
}

Fix

Add an explicit API version to controller routes via a path prefix or version attribute.