Sobes.tech
Middle

Quelles sont les règles de nommage des ressources en REST que tu connais?

sobes.tech IA

Réponse de l'IA

Dans une API RESTful, les ressources sont nommées avec des noms communs représentant des collections ou des instances d'objets.

Règles de nommage :

  • Utilisez le pluriel pour les collections : GET /products, POST /users.
  • Pour accéder à une ressource spécifique, utilisez l'identifiant : GET /products/123, PUT /users/john_doe.
  • Les ressources imbriquées sont nommées selon la hiérarchie : GET /users/john_doe/orders, DELETE /products/456/reviews/789.
  • Évitez les verbes dans l'URL : au lieu de GET /getAllProducts, utilisez GET /products. Les méthodes HTTP (GET, POST, PUT, DELETE) indiquent déjà l'action.
  • Utilisez des minuscules : GET /users est préféré à GET /Users.
  • Séparez les mots par des tirets : GET /product-categories est préféré à GET /productCategories.
  • N'utilisez pas d'extensions de fichiers : GET /users/john_doe est préféré à GET /users/john_doe.json. Le type de données est déterminé par les en-têtes Content-Type et Accept.
  • Utilisez des paramètres de requête pour le filtrage, le tri et la pagination : GET /products?category=electronics&sort=price&limit=10&offset=0.

Exemple :

// Obtenir la liste de toutes les commandes pour l'utilisateur avec l'ID 1
// GET /users/1/orders

// Créer un nouveau produit
// POST /products

// Obtenir les détails du produit avec l'ID 42
// GET /products/42

// Mettre à jour l'avis avec l'ID 10 pour le produit avec l'ID 5
// PUT /products/5/reviews/10