Ressources et URLs
Nommer les ressources en REST : pluriel, imbrication, et gestion des filtres, du tri et de la pagination via la query string.
En REST, l'URL désigne une ressource, pas une action. Bien nommer ses URLs rend l'API lisible et prévisible.
🏷️ Nommer au pluriel
On utilise le pluriel pour une collection, et l'identifiant pour un élément.
GET /articles # la collection
GET /articles/42 # un article précisÉvitez les verbes dans l'URL (/getArticle). Le verbe, c'est la méthode HTTP (GET, POST…). L'URL reste un nom de ressource.
🪜 Imbrication des ressources
Une ressource peut appartenir à une autre. On imbrique pour exprimer la relation.
GET /users/7/articles # articles de l'utilisateur 7
GET /users/7/articles/42 # article 42 de l'utilisateur 7N'imbriquez pas trop profondément (3 niveaux max en pratique). Au-delà, préférez un filtre : GET /comments?articleId=42.
🔎 Filtres, tri et pagination (query string)
La query string (?cle=valeur) transporte les paramètres d'interrogation sans changer la ressource.
GET /articles?categorie=tech&prixMax=50 # filtres
GET /articles?sort=-date&page=2&limit=20 # tri + pagination| Paramètre | Rôle |
|---|---|
categorie | filtrer par champ |
sort | trier (date asc, -date desc) |
page, limit | paginer les résultats |
🧩 Exemple complet
GET /articles?categorie=tech&sort=-date&page=1&limit=10 HTTP/1.1
Accept: application/jsonLa pagination protège le serveur et le réseau : ne jamais renvoyer 100 000 lignes d'un coup. Renvoyez un total et la page courante.
➡️ Suite
La page Méthodes et codes explique quel verbe et quel code de statut utiliser.
API REST
Terminez le quiz du chapitre pour le marquer comme complété.