API Sürümleme (ARCH4202)

Anahtar java.quality.api-versioning · Önem info · Kategori quality

Sürümsüz API’ler geriye dönük uyumu kıracak değişiklikleri imkânsız hale getirir. Rota yoluna açık bir sürüm ekleyerek istemcileri kırmadan ilerleyin.

Hatalı

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

Doğru

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

Düzeltme

Rota yoluna (/api/v1/...) veya bir sürüm anotasyonuna açık bir API sürümü ekleyin.