Aké pravidlá pre pomenovanie zdrojov v REST poznáš?

V RESTful API sú zdroje pomenované podstatnými menami, ktoré predstavujú kolekcie alebo inštancie objektov.

Pravidlá pomenovania:

• Používajte množné číslo pre kolekcie: GET /products, POST /users.
• Na prístup ku konkrétnemu zdroju použite identifikátor: GET /products/123, PUT /users/john_doe.
• Vnorené zdroje sa pomenúvajú hierarchicky: GET /users/john_doe/orders, DELETE /products/456/reviews/789.
• Vyhýbajte sa slovesám v URL: namiesto GET /getAllProducts používajte GET /products. Metódy HTTP (GET, POST, PUT, DELETE) už naznačujú akciu.
• Používajte malé písmená: GET /users je preferované pred GET /Users.
• Oddelujte slová pomlčkou: GET /product-categories je preferované pred GET /productCategories.
• Nezahrňujte prípony súborov: GET /users/john_doe je preferované pred GET /users/john_doe.json. Typ dát je určený v hlavičkach Content-Type a Accept.
• Používajte parametre dotazu na filtrovanie, zoradenie a stránkovanie: GET /products?category=electronics&sort=price&limit=10&offset=0.

Príklad:

// Získať zoznam všetkých objednávok používateľa s ID 1
// GET /users/1/orders

// Vytvoriť nový produkt
// POST /products

// Získať detaily produktu s ID 42
// GET /products/42

// Aktualizovať recenziu s ID 10 pre produkt s ID 5
// PUT /products/5/reviews/10