Eksik API Yanıt Tipi (ARCH3201)

Anahtar typescript.quality.missing-api-response · Önem info · Kategori quality

Yanıt şemasını ve durum kodlarını bildirmeyen HTTP denetleyici eylemleri, üretilen OpenAPI dokümantasyonunu eksik bırakır ve istemci sözleşmesini belirsizleştirir. Yanıt tipi açıkça açıklanmalıdır.

Hatalı

@Get(":id")
findOne(@Param("id") id: string) {
  return this.svc.find(id);
}

Doğru

@Get(":id")
@ApiResponse({ status: 200, type: UserDto })
@ApiResponse({ status: 404 })
findOne(@Param("id") id: string): Promise<UserDto> {
  return this.svc.find(id);
}

Düzeltme

Eylemlerin yanıt tipini ve durum kodlarını şema dekoratörleriyle açıkça bildirin.