Eksik API Yanıt Tipi (ARCH4201)

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

Yanıt durum kodlarını bildirmeyen aksiyonlar üretilen OpenAPI dokümanını eksik bırakır. Beklenen durum kodlarını açıkça işaretleyin.

Hatalı

@PostMapping("/orders")
public Order create(@RequestBody Order order) {
    return service.create(order);
}

Doğru

@PostMapping("/orders")
@ApiResponses({
    @ApiResponse(responseCode = "201", description = "Created"),
    @ApiResponse(responseCode = "400", description = "Invalid input")
})
@ResponseStatus(HttpStatus.CREATED)
public Order create(@RequestBody @Valid Order order) {
    return service.create(order);
}

Düzeltme

Aksiyona @ResponseStatus ve @ApiResponse anotasyonlarıyla beklenen durum kodlarını ekleyin.