Middle
Milyen erőforrásnevezési szabályokat ismersz a REST-ben?
sobes.tech MI
Válasz az MI-től
Egy RESTful API-ban az erőforrásokat főnevekkel nevezik el, amelyek gyűjteményeket vagy példányokat képviselnek.
Névadási szabályok:
- Használjon többes számot a gyűjteményekhez:
GET /products,POST /users. - Egy adott erőforráshoz való hozzáféréshez használja az azonosítót:
GET /products/123,PUT /users/john_doe. - A beágyazott erőforrásokat hierarchikusan nevezze el:
GET /users/john_doe/orders,DELETE /products/456/reviews/789. - Kerülje az igéket az URL-ben: a
GET /getAllProductshelyett használja aGET /products-t. A HTTP-módszerek (GET,POST,PUT,DELETE) már utalnak a műveletre. - Használjon kisbetűket: a
GET /userselőnyösebb, mint aGET /Users. - Szavakat válasszon kötőjellel elválasztva:
GET /product-categorieselőnyösebb, mint aGET /productCategories. - Ne használjon fájl kiterjesztéseket: a
GET /users/john_doeelőnyösebb, mint aGET /users/john_doe.json. Az adattípus aContent-TypeésAcceptfejlécben van meghatározva. - Használjon lekérdezési paramétereket szűréshez, rendezéshez és lapozáshoz:
GET /products?category=electronics&sort=price&limit=10&offset=0.
Példa:
// Az összes rendelés listájának lekérése az ID 1-es felhasználó számára
// GET /users/1/orders
// Új termék létrehozása
// POST /products
// A 42-es ID-jű termék részleteinek lekérése
// GET /products/42
// A 10-es ID-jű értékelés frissítése az ID 5-ös termékhez
// PUT /products/5/reviews/10