Welche Namensregeln für Ressourcen in REST kennst du?

In einer RESTful API werden Ressourcen mit Substantiven benannt, die Sammlungen oder Instanzen von Objekten darstellen.

Namensregeln:

• Verwenden Sie den Plural für Sammlungen: GET /products, POST /users.
• Um auf eine bestimmte Ressource zuzugreifen, verwenden Sie die Kennung: GET /products/123, PUT /users/john_doe.
• Verschachtelte Ressourcen werden hierarchisch benannt: GET /users/john_doe/orders, DELETE /products/456/reviews/789.
• Vermeiden Sie Verben in der URL: Statt GET /getAllProducts verwenden Sie GET /products. Die HTTP-Methoden (GET, POST, PUT, DELETE) geben die Aktion bereits an.
• Verwenden Sie Kleinbuchstaben: GET /users ist bevorzugt gegenüber GET /Users.
• Worttrennung durch Bindestriche: GET /product-categories ist bevorzugt gegenüber GET /productCategories.
• Vermeiden Sie Dateierweiterungen: GET /users/john_doe ist bevorzugt gegenüber GET /users/john_doe.json. Der Datentyp wird in den Headern Content-Type und Accept bestimmt.
• Verwenden Sie Abfrageparameter für Filterung, Sortierung und Paginierung: GET /products?category=electronics&sort=price&limit=10&offset=0.

Beispiel:

// Alle Bestellungen des Benutzers mit ID 1 abrufen
// GET /users/1/orders

// Neues Produkt erstellen
// POST /products

// Details des Produkts mit ID 42 abrufen
// GET /products/42

// Bewertung mit ID 10 für das Produkt mit ID 5 aktualisieren
// PUT /products/5/reviews/10