Welke regels voor het benoemen van resources in REST ken je?

In een RESTful API worden resources benoemd met zelfstandige naamwoorden die verzamelingen of instanties van objecten vertegenwoordigen.

Naamgevingsregels:

• Gebruik meervoud voor verzamelingen: GET /products, POST /users.
• Gebruik de identificator om toegang te krijgen tot een specifiek resource: GET /products/123, PUT /users/john_doe.
• Geneste resources worden hiërarchisch benoemd: GET /users/john_doe/orders, DELETE /products/456/reviews/789.
• Vermijd werkwoorden in de URL: in plaats van GET /getAllProducts, gebruik GET /products. De HTTP-methoden (GET, POST, PUT, DELETE) geven al de actie aan.
• Gebruik kleine letters: GET /users heeft de voorkeur boven GET /Users.
• Scheide woorden met koppelteken: GET /product-categories heeft de voorkeur boven GET /productCategories.
• Gebruik geen bestandsuitbreidingen: GET /users/john_doe heeft de voorkeur boven GET /users/john_doe.json. Het datatypes wordt bepaald door de headers Content-Type en Accept.
• Gebruik queryparameters voor filtering, sortering en paginering: GET /products?category=electronics&sort=price&limit=10&offset=0.

Voorbeeld:

// Haal de lijst op van alle bestellingen voor gebruiker met ID 1
// GET /users/1/orders

// Maak een nieuw product
// POST /products

// Haal details op van product met ID 42
// GET /products/42

// Werk review met ID 10 bij voor product met ID 5
// PUT /products/5/reviews/10