Sobes.tech
Middle

Ce reguli de denumire a resurselor în REST cunoști?

sobes.tech AI

Răspuns de la AI

Într-o API RESTful, resursele sunt denumite cu substantive care reprezintă colecții sau instanțe de obiecte.

Reguli de denumire:

  • Folosiți pluralul pentru colecții: GET /products, POST /users.
  • Pentru a accesa o resursă specifică, folosiți identificatorul: GET /products/123, PUT /users/john_doe.
  • Resursele imbricate sunt denumite ierarhic: GET /users/john_doe/orders, DELETE /products/456/reviews/789.
  • Evitați verbele în URL: în loc de GET /getAllProducts, folosiți GET /products. Metodele HTTP (GET, POST, PUT, DELETE) indică deja acțiunea.
  • Folosiți litere mici: GET /users este preferabil față de GET /Users.
  • Despărțiți cu cratime: GET /product-categories este preferabil față de GET /productCategories.
  • Nu folosiți extensii de fișiere: GET /users/john_doe este preferabil față de GET /users/john_doe.json. Tipul de date este determinat de anteturile Content-Type și Accept.
  • Folosiți parametri de interogare pentru filtrare, sortare și paginare: GET /products?category=electronics&sort=price&limit=10&offset=0.

Exemplu:

// Obțineți lista tuturor comenzilor pentru utilizatorul cu ID 1
// GET /users/1/orders

// Creați un produs nou
// POST /products

// Obțineți detalii despre produsul cu ID 42
// GET /products/42

// Actualizați recenzia cu ID 10 pentru produsul cu ID 5
// PUT /products/5/reviews/10