API REST

 

APIs REST

REST (Representational State Transfer) est le style le plus utilisé pour exposer des services web.

Principes REST

GET

Lire des données

GET /api/users/1

Réponse :

{
  "id": 1,
  "name": "John"
}

---

POST

Créer

POST /api/users

---

PUT

Modifier complètement

PUT /api/users/1

---

PATCH

Modifier partiellement

PATCH /api/users/1

---

DELETE

Supprimer

DELETE /api/users/1

---

Exemple Controller

[ApiController]
[Route("api/users")]
public class UsersController : ControllerBase
{
    [HttpGet("{id}")]
    public IActionResult Get(int id)
    {
        return Ok();
    }

    [HttpPost]
    public IActionResult Create(UserDto dto)
    {
        return Created();
    }
}

---

Bonnes pratiques REST

Codes HTTP

200 OK
201 Created
204 No Content
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Versioning

/api/v1/users
/api/v2/users

Pagination

/api/users?page=1&pageSize=20

---

Réponse entretien

Une API REST expose des ressources via HTTP en utilisant des verbes comme GET, POST, PUT et DELETE. Elle doit être stateless, utiliser les codes HTTP appropriés et proposer des mécanismes comme la pagination, le versioning et la sécurisation via JWT ou OAuth.