Метод PUT: замена товара
Как администратор заменяет товар целиком: PUT-запрос с полными данными, код 200, и чем PUT отличается от PATCH.
О продукте
Привет! С изменением цены всё понятно. А если нужно обновить товар целиком: и название, и цену? Сегодня смотрим второй способ изменения — метод PUT — и сравниваем его с PATCH.
Понятно! А как это работает?
Всё объяснит Кадри: Кадри уже ждёт тебя в переговорке. Разбираем только позитивный сценарий: всё идёт как надо.
Привет! С PATCH ты уже знаком: он меняет часть данных. Для полной замены товара в HTTP есть метод PUT.
Привет, Кадри! Чем PUT отличается от PATCH?
PUT значит «заменить целиком». Клиент указывает в адресе товар и присылает в теле все его данные: и название, и цену. Сервер заменяет ими товар полностью. Вот пример для товара с id 5:
Запрос
PUT /api/v1/products/5
{
"name": "Ржаной хлеб, 400 г",
"price": 1.99
}- метод — что сделать.
PUTзначит «заменить целиком» - адрес — с чем.
/api/v1/products/5— товар сid5 - тело запроса (request body) — полные данные товара: название и цена. Даже если менялось только одно поле, отправляют всё
А что сервер отвечает на PUT?
Сервер заменяет данные товара в базе и отвечает кодом 200 OK. В теле ответа он возвращает товар целиком. id остаётся прежним: PUT меняет содержимое, а не номер товара.
Ответ
200 OK
{
"id": 5,
"name": "Ржаной хлеб, 400 г",
"price": 1.99
}- код статуса — как всё прошло.
200 OKзначит «успешно» - тело ответа (response body) — товар целиком:
id, название и цена
На заметку: 200 — частый, но не единственный вариант. В зависимости от реализации сервер может ответить, например, 204 No Content без тела или 201 Created, если товара с таким id ещё не было и PUT его создал.
Проверим. В чём главное отличие PUT от PATCH?
Давай посмотрим на практике!
Вот админка BB Food. Выбери товар, измени название и цену и нажми «Сохранить товар». Обрати внимание: в форме оба поля, потому что PUT отправляет товар целиком.
Тестируемое приложение
Сценарий. Позитивный: администратор заменяет данные товара
Сервер ждёт запросов. Нажми «Сохранить товар», чтобы клиент отправил запрос PUT.
Анимация замедлена: в реальности весь путь занимает десятки миллисекунд.
| id | name | price |
|---|
Введите название и цену — число больше нуля.
В каталоге больше нет товаров.
Готово! Сервер вернул 200 OK и товар целиком. В таблице обновилась вся строка: и название, и цена, а id остался прежним.
Администратор изменил в форме только цену, но нажал «Сохранить товар». Что клиент отправит в теле PUT?
А что мне тут проверять?
Проверь три вещи. Первое: код ответа 200 OK, а в теле — товар целиком с новыми данными. Второе: в таблице базы данных обновились название и цена, а id не изменился. Третье: отдельный запрос GET /api/v1/products возвращает товар уже с новыми названием и ценой, их увидят и покупатели.
Справка по теме
Метод PUT
PUT /api/v1/products/5 означает «заменить целиком». В теле запроса отправляют все данные объекта, и сервер заменяет ими прежние.
Код 200 OK
Успешный ответ. Сервер возвращает в теле товар целиком, уже с новыми данными. Сам id при замене не меняется.
PUT и PATCH
PUT отправляет все поля, даже если изменилось только одно. PATCH отправляет только изменяемые поля.
Что проверяет тестировщик
Код ответа 200, в теле — товар с новыми данными. В базе обновились название и цена, id прежний. Новые данные видны в админке и в каталоге.