Jaká pravidla pojmenování zdrojů v REST znáš?

V RESTful API jsou zdroje pojmenovány podstatnými jmény představujícími kolekce nebo instance objektů.

Pravidla pojmenování:

• Používejte množné číslo pro kolekce: GET /products, POST /users.
• Pro přístup ke konkrétnímu zdroji použijte identifikátor: GET /products/123, PUT /users/john_doe.
• Vnořené zdroje pojmenujte hierarchicky: GET /users/john_doe/orders, DELETE /products/456/reviews/789.
• Vyhněte se slovesům v URL: místo GET /getAllProducts používejte GET /products. Metody HTTP (GET, POST, PUT, DELETE) již naznačují akci.
• Používejte malá písmena: GET /users je preferováno před GET /Users.
• Oddělujte slova pomlčkami: GET /product-categories je preferováno před GET /productCategories.
• Nepoužívejte přípony souborů: GET /users/john_doe je preferováno před GET /users/john_doe.json. Typ dat je určen hlavičkami Content-Type a Accept.
• Používejte dotazové parametry pro filtrování, třídění a stránkování: GET /products?category=electronics&sort=price&limit=10&offset=0.

Příklad:

// Získat seznam všech objednávek uživatele s ID 1
// GET /users/1/orders

// Vytvořit nový produkt
// POST /products

// Získat detaily produktu s ID 42
// GET /products/42

// Aktualizovat recenzi s ID 10 pro produkt s ID 5
// PUT /products/5/reviews/10