Api Versioning (ARCH4202)

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

Unversioned APIs make backward-incompatible changes impossible to ship safely. Add an explicit version to the route path so you can evolve without breaking clients.

Incorrect

@RestController
@RequestMapping("/orders")
class OrderController {
    @GetMapping("/{id}")
    Order get(@PathVariable long id) { return service.find(id); }
}

Correct

@RestController
@RequestMapping("/api/v1/orders")
class OrderController {
    @GetMapping("/{id}")
    Order get(@PathVariable long id) { return service.find(id); }
}

Fix

Add an explicit API version to the route path (/api/v1/...) or via a version attribute.