Missing produces response type (ARCH801)

Anahtar dotnet.api.missing-produces-response-type · Önem info · Kategori api

ProducesResponseType öznitelikleri olmayan aksiyonlar, OpenAPI/Swagger dokümantasyonunda eksik veya yanlış yanıt şemaları üretir. Olası durum kodları açıkça bildirilmelidir.

Hatalı

[HttpGet("{id}")]
public async Task<IActionResult> GetById(int id)
{
    var user = await _service.FindAsync(id);
    return user is null ? NotFound() : Ok(user);
}

Doğru

[HttpGet("{id}")]
[ProducesResponseType(typeof(UserResponse), StatusCodes.Status200OK)]
[ProducesResponseType(StatusCodes.Status404NotFound)]
public async Task<IActionResult> GetById(int id)
{
    var user = await _service.FindAsync(id);
    return user is null ? NotFound() : Ok(user);
}

Düzeltme

Her aksiyonun döndürebileceği durum kodları ve gövde tipleri için [ProducesResponseType] öznitelikleri ekleyin.