Какие HTTP-коды ответа ожидать при успешном создании, обновлении и полной замене ресурса?

Основные коды ответа

В REST API коды состояния HTTP сообщают клиенту о результате выполнения запроса. Для операций создания, обновления и замены ресурса используются разные коды, которые помогают клиенту понять, что произошло на сервере.

Создание ресурса (POST)

Когда клиент отправляет POST-запрос для создания нового ресурса, сервер должен вернуть код 201 Created. Этот код указывает, что ресурс был успешно создан, и в ответе обычно содержится ссылка на новый ресурс в заголовке Location. Например, при создании пользователя сервер может вернуть:

HTTP/1.1 201 Created
Location: /users/123
Content-Type: application/json

{"id": 123, "name": "Alice"}

Обновление ресурса (PATCH или PUT)

Для обновления существующего ресурса используются методы PATCH (частичное обновление) и PUT (полная замена). В обоих случаях при успешном выполнении обычно возвращается код 200 OK с обновлённым представлением ресурса в теле ответа. Если сервер не возвращает тело ответа, допустимо использовать код 204 No Content. Например:

PATCH /users/123
{"name": "Bob"}

HTTP/1.1 200 OK
{"id": 123, "name": "Bob"}

Полная замена ресурса (PUT)

Метод PUT предназначен для полной замены ресурса. Если клиент отправляет PUT-запрос на существующий ресурс, сервер заменяет его целиком. Успешный ответ — 200 OK с новым представлением или 204 No Content, если тело не требуется. Важно помнить, что PUT идемпотентен: повторный запрос с теми же данными не должен изменять состояние ресурса.

Вывод

Используйте 201 Created для создания, 200 OK для обновления и замены с телом ответа, и 204 No Content, когда ответ не содержит данных. Это стандартные практики, которые делают API предсказуемым и понятным для клиентов.