Middle
Jakie zasady nazewnictwa zasobów w REST znasz?
sobes.tech AI
Odpowiedź od AI
W RESTful API zasoby nazywane są rzeczownikami, które reprezentują kolekcje lub instancje obiektów.
Zasady nazewnictwa:
- Używaj liczby mnogiej dla kolekcji:
GET /products,POST /users. - Aby uzyskać dostęp do konkretnego zasobu, użyj identyfikatora:
GET /products/123,PUT /users/john_doe. - Zasoby zagnieżdżone nazywaj hierarchicznie:
GET /users/john_doe/orders,DELETE /products/456/reviews/789. - Unikaj czasowników w URL: zamiast
GET /getAllProducts, użyjGET /products. Metody HTTP (GET,POST,PUT,DELETE) już wskazują na działanie. - Używaj małych liter:
GET /usersjest preferowane nadGET /Users. - Oddziel słowa myślnikami:
GET /product-categoriesjest preferowane nadGET /productCategories. - Nie używaj rozszerzeń plików:
GET /users/john_doejest preferowane nadGET /users/john_doe.json. Typ danych jest określany w nagłówkachContent-TypeiAccept. - Używaj parametrów zapytania do filtrowania, sortowania i paginacji:
GET /products?category=electronics&sort=price&limit=10&offset=0.
Przykład:
// Pobierz listę wszystkich zamówień dla użytkownika o ID 1
// GET /users/1/orders
// Utwórz nowy produkt
// POST /products
// Pobierz szczegóły produktu o ID 42
// GET /products/42
// Zaktualizuj opinię o ID 10 dla produktu o ID 5
// PUT /products/5/reviews/10