Bezdepbonusu7Программирование: статьи и ответы

Веб и API

Методы HTTP-запросов: чем отличаются GET, POST, PUT, PATCH, DELETE

HTTP-методы сообщают серверу, что сделать с ресурсом: прочитать (GET), создать (POST), заменить (PUT), изменить часть (PATCH) или удалить (DELETE). Они различаются безопасностью и идемпотентностью, от этого зависит, можно ли повторять запрос при сбое. Ниже таблицы, правила выбора метода и рабочие примеры на curl и JavaScript.

Методы HTTP-запросов: чем отличаются GET, POST, PUT, PATCH, DELETE
Содержание
  1. Что такое HTTP-метод
  2. Основные методы и их назначение
  3. GET: получение данных
  4. POST: создание и действия
  5. PUT и PATCH: полная и частичная замена
  6. DELETE, HEAD и OPTIONS
  7. Безопасность и идемпотентность методов
  8. Примеры запросов в curl
  9. Примеры запросов в JavaScript через fetch
  10. Как выбрать метод для задачи
  11. Новый метод QUERY и ошибка 405
  12. Частые вопросы

Что такое HTTP-метод

Каждый HTTP-запрос начинается со слова, которое говорит серверу, что нужно сделать с ресурсом по указанному адресу. Это слово и есть метод: прочитать, создать, заменить, удалить. Адрес отвечает на вопрос "что", метод - на вопрос "что с этим делать".

Методов в стандарте немного. Для повседневной работы с API хватает пяти-семи, и именно они обычно спрашивают на собеседованиях. Если нужна общая картина про взаимодействие программ, начните со статьи что такое API.

У сервера есть ещё и ответ: код состояния сообщает, чем закончился запрос. Эту часть разбирает отдельный материал о кодах ответов HTTP, а здесь речь о том, что мы отправляем.

Основные методы и их назначение

МетодНазначениеТело запросаТипичный успешный ответ
GETполучить ресурс или списокнет200
POSTсоздать ресурс или запустить действиеда201 или 200
PUTполностью заменить ресурсда200 или 204
PATCHизменить часть ресурсада200 или 204
DELETEудалить ресурсобычно нет204 или 200
HEADполучить только заголовкинет200
OPTIONSузнать, какие методы разрешенынет200 или 204

Названия методов пишутся заглавными буквами, и это не просто привычка: для стандарта метод чувствителен к регистру, get и GET считаются разными.

GET: получение данных

GET запрашивает представление ресурса и не должен ничего менять на сервере. Параметры передаются в строке адреса после знака вопроса, например /users?page=2&limit=20. Тела у такого запроса обычно нет.

Ответы на GET кэшируются браузером и промежуточными серверами, поэтому через него нельзя передавать пароли и другие секреты: адрес попадает в историю браузера и журналы сервера.

POST: создание и действия

POST отправляет данные на сервер, чаще всего чтобы создать новую запись: пользователя, заказ, комментарий. Данные идут в теле запроса, чаще в формате JSON (о нём в статье JSON: что это такое) или как данные формы.

Если запись создана, сервер обычно отвечает кодом 201 и присылает адрес или содержимое новой записи. Повторная отправка того же POST создаст ещё одну запись, поэтому POST не считается идемпотентным.

PUT и PATCH: полная и частичная замена

PUT кладёт по адресу ресурса полную новую версию. Если вы отправили объект без какого-то поля, то на сервере поле может исчезнуть. Повторный PUT с теми же данными оставляет ресурс в том же состоянии, значит, метод идемпотентный.

PATCH меняет только перечисленные поля. Он удобнее, когда нужно обновить одно значение, но стандарт не гарантирует идемпотентности: запрос вида "увеличить счётчик на 1" при повторе даст другой результат.

DELETE, HEAD и OPTIONS

DELETE удаляет ресурс. Первый запрос обычно возвращает 204 или 200, повторный - 404, потому что ресурса уже нет. Состояние сервера после обоих запросов одинаковое, поэтому метод остаётся идемпотентным, хотя коды ответа различаются.

HEAD работает как GET, но сервер присылает только заголовки без тела. Так проверяют, существует ли страница, и узнают размер файла по заголовку Content-Length, не скачивая его.

OPTIONS спрашивает, какие методы поддерживает адрес. Браузер сам отправляет такой запрос перед некоторыми межсайтовыми вызовами (CORS), чтобы выяснить, разрешены ли они. Ответ содержит заголовок Allow или заголовки Access-Control-Allow-*.

Безопасность и идемпотентность методов

В спецификации HTTP используются два понятия. Безопасный метод не предназначен для изменения данных: он только читает. Идемпотентный метод даёт тот же итог на сервере при одном запросе и при нескольких одинаковых подряд.

МетодБезопасныйИдемпотентный
GETдада
HEADдада
OPTIONSдада
PUTнетда
DELETEнетда
POSTнетнет
PATCHнетнет, не гарантируется

Практический смысл простой. Идемпотентный запрос можно повторить, если ответ не пришёл из-за обрыва связи: двойного эффекта не будет. С POST так делать опасно, иначе заказ или платёж задвоится. Для таких случаев в API вводят специальный ключ идемпотентности в заголовке.

Безопасность метода описывает намерение, а не гарантию. Если разработчик сделал так, что GET /delete?id=5 удаляет запись, то поисковый робот или предзагрузка браузера удалит данные, просто пройдя по ссылке. Изменяющие действия всегда выносите в POST, PUT, PATCH или DELETE.

Примеры запросов в curl

Утилита curl есть в Linux, macOS и современной Windows. Для проверки удобен открытый тестовый сервис jsonplaceholder.typicode.com: он принимает все методы, но ничего не сохраняет. Следующие команды получают, создают, заменяют, меняют и удаляют запись.

# GET: получить запись с номером 1
curl https://jsonplaceholder.typicode.com/posts/1

# POST: создать запись, данные в теле в формате JSON
curl -X POST https://jsonplaceholder.typicode.com/posts \
  -H "Content-Type: application/json" \
  -d '{"title": "Привет", "body": "Текст", "userId": 1}'

# PUT: заменить запись целиком
curl -X PUT https://jsonplaceholder.typicode.com/posts/1 \
  -H "Content-Type: application/json" \
  -d '{"id": 1, "title": "Новый", "body": "Текст", "userId": 1}'

# PATCH: изменить только заголовок
curl -X PATCH https://jsonplaceholder.typicode.com/posts/1 \
  -H "Content-Type: application/json" \
  -d '{"title": "Только заголовок"}'

# DELETE: удалить запись
curl -X DELETE https://jsonplaceholder.typicode.com/posts/1

Для GET и POST ответ придёт в виде JSON, а у DELETE тело будет пустым объектом. Флаг -i добавляет к выводу код ответа и заголовки.

Пример запроса POST в терминале с помощью curl
Запрос POST на curl: метод, адрес и тело в одной команде
# HEAD: только заголовки
curl -I https://jsonplaceholder.typicode.com/posts/1

# OPTIONS: какие методы разрешены (с выводом заголовков)
curl -i -X OPTIONS https://jsonplaceholder.typicode.com/posts/1

Если команды лень набирать в терминале, те же запросы можно собрать мышью в программе, о которой рассказано в статье как пользоваться Postman.

Примеры запросов в JavaScript через fetch

Функция fetch встроена в браузеры и Node.js. Метод задаётся в параметре method, тело - в body, а заголовки - в headers. Fetch возвращает промис, поэтому удобнее использовать async и await.

const base = "https://jsonplaceholder.typicode.com/posts";

async function demo() {
  // GET
  const one = await fetch(base + "/1");
  console.log(one.status, await one.json());

  // POST
  const created = await fetch(base, {
    method: "POST",
    headers: { "Content-Type": "application/json" },
    body: JSON.stringify({ title: "Привет", body: "Текст", userId: 1 }),
  });
  console.log(created.status, await created.json());

  // PATCH
  const patched = await fetch(base + "/1", {
    method: "PATCH",
    headers: { "Content-Type": "application/json" },
    body: JSON.stringify({ title: "Новый заголовок" }),
  });
  console.log(patched.status);

  // DELETE
  const removed = await fetch(base + "/1", { method: "DELETE" });
  console.log(removed.status);
}

demo();

Статус POST будет 201, остальные запросы вернут 200. Важная деталь: fetch не выбрасывает ошибку на коды 404 или 500, он считает запрос выполненным. Проверяйте свойство response.ok сами. Сравнение fetch с популярной библиотекой есть в статье Axios vs Fetch, а базовые вызовы описаны в материале как сделать HTTP-запрос в JavaScript.

Как выбрать метод для задачи

  1. Нужно только прочитать данные: GET.
  2. Создаёте новую запись, адрес которой назначит сервер: POST на адрес коллекции, например /users.
  3. Заменяете запись целиком по известному адресу: PUT на /users/5.
  4. Меняете одно-два поля: PATCH на /users/5.
  5. Удаляете запись: DELETE на /users/5.
  6. Запускаете действие, которое не укладывается в записи, например отправку письма или расчёт: POST.

В хорошем REST API адрес содержит существительное во множественном числе (/orders), а действие определяется методом. Адреса вроде /getOrders и /deleteOrder считаются плохим стилем, ведь глагол уже передан методом.

Новый метод QUERY и ошибка 405

У GET есть ограничение: длинные и сложные условия поиска неудобно передавать в адресе. Поэтому появился метод QUERY. Он безопасный и идемпотентный, как GET, но допускает тело запроса. Метод описан в RFC 10008, однако поддержка в серверах, прокси и библиотеках растёт постепенно, поэтому проверяйте её перед использованием.

Ошибка "метод не поддерживается" в ответе выглядит как код 405 Method Not Allowed. Она означает, что адрес существует, но не принимает ваш метод, например вы отправили POST на адрес только для чтения. В заголовке Allow ответа сервер обычно перечисляет разрешённые методы.

Форматированный ответ сервера удобно проверять в форматировщике JSON.

Частые вопросы

Какие бывают HTTP-методы?

Основные: GET, POST, PUT, PATCH, DELETE, HEAD и OPTIONS. Есть и редкие, например CONNECT и TRACE, а также новый QUERY.

Чем отличается PUT от PATCH?

PUT полностью заменяет ресурс переданной версией, а PATCH меняет только указанные поля. PUT идемпотентный, PATCH по стандарту этого не гарантирует.

Какие методы HTTP идемпотентные?

GET, HEAD, OPTIONS, PUT и DELETE. POST и PATCH не гарантируют идемпотентности.

Какие методы HTTP безопасные?

Безопасными считаются GET, HEAD и OPTIONS: они только читают данные и не должны менять состояние сервера.

Чем POST отличается от GET?

GET читает данные и передаёт параметры в адресе, а POST отправляет данные в теле запроса и обычно создаёт запись или запускает действие. Повтор POST может создать дубликат.

Зачем нужен метод OPTIONS?

Он показывает, какие методы разрешены для адреса. Браузер отправляет его сам перед некоторыми кросс-доменными запросами, чтобы проверить правила CORS.

Что значит ошибка 405 Method Not Allowed?

Адрес существует, но не принимает использованный метод. Список разрешённых методов смотрите в заголовке Allow ответа или в документации API.

Источники

HTTPAPI

Похожие материалы

Версии программ и команды проверены на дату публикации. Если что-то изменилось, сверяйтесь с официальной документацией. Нашли неточность? Напишите на admin@bezdepbonusu7.win.