Sobes.tech
Middle
128
questionbank

Какие правила наименования ресурсов в REST ты знаешь?

Answer from AI

sobes.tech 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