Sobes.tech
Junior — Middle
91

API контроллерлерін жасағанда REST қағидаттарын ұстанасыз ба?

Сұралған компаниялар
Банк ПСБ

AI-дан жауап

sobes.tech AI

Иә, API контроллерлерін жасағанда мен REST қағидаттарына сәйкес болуға тырысамын, бұл сервистің өзара әрекеттесуін ыңғайлы әрі болжамды етеді. Мен ескере отырып, негізгі REST қағидаттары:

  • Дұрыс HTTP әдістерін пайдалану: мәліметтерді алу үшін GET, жасау үшін POST, жаңарту үшін PUT/PATCH, жою үшін DELETE.
  • Ресурстар құрылымын көрсететін нақты URL иерархиясы, мысалы /api/products/123.
  • Серверде күйдің болмауы (stateless), яғни әр сұрау қажетті барлық ақпаратты қамтуы керек.
  • Операция нәтижесі туралы клиентке хабарлау үшін стандартты HTTP жауап кодтарын пайдалану.

C# тілінде ASP.NET Core қолдана отырып қарапайым REST API контроллерінің мысалы:

[ApiController]
[Route("api/[controller]")]
public class ProductsController : ControllerBase
{
    [HttpGet("{id}")]
    public IActionResult GetProduct(int id)
    {
        var product = _repository.GetProductById(id);
        if (product == null) return NotFound();
        return Ok(product);
    }

    [HttpPost]
    public IActionResult CreateProduct(Product product)
    {
        _repository.AddProduct(product);
        return CreatedAtAction(nameof(GetProduct), new { id = product.Id }, product);
    }

    // Басқа PUT, DELETE әдістері және т.б.
}

Мұндай тәсіл API-дің қолдауын және масштабталуын жеңілдетеді.