API Sürümleme (ARCH3202)

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

Açık bir API sürümü taşımayan denetleyiciler, geriye dönük uyumsuz değişiklikleri mevcut istemcileri kırmadan yapmayı imkansızlaştırır. Rota yolu veya öznitelikle sürüm açıkça belirtilmelidir.

Hatalı

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

Doğru

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

Düzeltme

Denetleyici rotalarına yol önekiyle veya sürüm özniteliğiyle açık bir API sürümü ekleyin.