Kādas ir resursu nosaukšanas noteikumi REST?

RESTful API resursi tiek nosaukti aritmētiskajiem vārdiem, kas pārstāv kolekcijas vai objekta piemērus.

Nosaukšanas noteikumi:

• Izmantojiet daudzskaitli kolekcijām: GET /products, POST /users.
• Lai piekļūtu konkrētam resursam, izmantojiet identifikatoru: GET /products/123, PUT /users/john_doe.
• Iekšējie resursi tiek nosaukti hierarhiski: GET /users/john_doe/orders, DELETE /products/456/reviews/789.
• Izvairieties no darbības vārdiem URL: vietā GET /getAllProducts, lietojiet GET /products. HTTP metodes (GET, POST, PUT, DELETE) jau norāda uz darbību.
• Lietojiet mazos burtus: GET /users ir priekšroka pār GET /Users.
• Vārdu atdalīšanai lietojiet domuzīmi: GET /product-categories ir priekšroka pār GET /productCategories.
• Nepievienojiet failu paplašinājumus: GET /users/john_doe ir priekšroka pār GET /users/john_doe.json. Datu tips tiek noteikts pēc Content-Type un Accept galvenēm.
• Lietojiet vaicājuma parametrus filtrēšanai, kārtošanai un lapošanai: GET /products?category=electronics&sort=price&limit=10&offset=0.

Piemērs:

// Saņemt visu pasūtījumu sarakstu lietotājam ar ID 1
// GET /users/1/orders

// Izveidot jaunu produktu
// POST /products

// Saņemt produkta detaļas ar ID 42
// GET /products/42

// Atjaunināt atsauksmi ar ID 10 par produktu ar ID 5
// PUT /products/5/reviews/10