Action naming (ARCH802)

Anahtar dotnet.api.action-naming · Önem info · Kategori api

API aksiyon adları HTTP fiilini tekrarlamak yerine kaynağı temsil etmelidir. Tutarlı RESTful adlandırma, API’yi öngörülebilir kılar.

Hatalı

[HttpGet]
public IActionResult GetAllUsersList() => Ok(_service.All());

[HttpPost]
public IActionResult DoCreateUser(CreateUserRequest request) => Ok();

Doğru

[HttpGet]
public IActionResult List() => Ok(_service.All());

[HttpPost]
public IActionResult Create(CreateUserRequest request) => Ok();

Düzeltme

Aksiyon adlarını HTTP fiilinin ima ettiği eylemi tekrarlamadan, kaynak odaklı ve tutarlı olacak şekilde yeniden adlandırın.