Middle
Какви правила за именуване на ресурси в REST знаеш?
sobes.tech AI
Отговор от AI
В RESTful API ресурсите се именуват с съществителни, които представляват колекции или екземпляри от обекти.
Правила за именуване:
- Използвайте множествено число за колекции:
GET /products,POST /users. - За достъп до конкретен ресурс използвайте идентификатор:
GET /products/123,PUT /users/john_doe. - Вложените ресурси се именуват йерархично:
GET /users/john_doe/orders,DELETE /products/456/reviews/789. - Избягвайте глаголи в URL: вместо
GET /getAllProducts, използвайтеGET /products. HTTP методите (GET,POST,PUT,DELETE) вече указват действието. - Използвайте малки букви:
GET /usersе по-препоръчително отGET /Users. - Разделяйте думите с тирета:
GET /product-categoriesе по-препоръчително отGET /productCategories. - Не използвайте разширения на файлове:
GET /users/john_doeе по-препоръчително отGET /users/john_doe.json. Типът на данните се определя от заглавкитеContent-TypeиAccept. - Използвайте заявъчни параметри за филтриране, сортиране и странициране:
GET /products?category=electronics&sort=price&limit=10&offset=0.
Пример:
// Получаване на списък с всички поръчки за потребител с ID 1
// GET /users/1/orders
// Създаване на нов продукт
// POST /products
// Получаване на детайли за продукт с ID 42
// GET /products/42
// Актуализиране на отзив с ID 10 за продукт с ID 5
// PUT /products/5/reviews/10