Составьте HTTP-запрос по шагам — переменные пути вроде
{userId}, параметры строки запроса, заголовки, тела JSON / form и аутентификацию — и получите готовый к запуску код для
cURL,
Node.js fetch,
Python requests или
PowerShell. Этот инструмент предназначен для
проектирования и генерации; чтобы отправить запрос и посмотреть живой ответ, передайте его кнопкой
Тестировать запрос → (откроется
клиент и тестировщик REST API) или преобразуйте вставленную команду cURL с помощью
конвертера команд cURL.
Всё собирается локально в вашем браузере. С этой страницы никакие запросы не отправляются.
Советы: заключите сегмент URL в фигурные скобки (
{userId}), чтобы управлять им как параметром пути; сгенерированный код обновляется при каждом изменении. Запросы GET и HEAD игнорируют тело. Загрузка файлов в сгенерированном коде использует вид
@file в cURL или заполнители в других языках — подключайте настоящие файлы в собственном коде. Отправка с другого источника (cross-origin) описана в
клиенте REST API (соблюдайте политику CORS сервера); чтобы разобрать существующую команду, используйте
конвертер команд cURL.
HTTP-методы — пояснения
Когда вы выбираете метод, сгенерированный код cURL / Node / Python / PowerShell меняется в соответствии с ним. Вот что означает каждый глагол для составляемого вами запроса:
GET — получить представление ресурса. Он не должен менять состояние сервера, и сгенерированный запрос обычно не имеет тела. Используйте GET для чтения, поиска и эндпоинтов-списков.
POST — отправить данные для создания нового ресурса или запуска действия. Тело становится полезной нагрузкой в сгенерированном коде (--data-raw в cURL, аргумент body в Node и Python и т. д.). POST не идемпотентен: если отправить его дважды, могут создаться два ресурса.
PUT — полностью заменить существующий ресурс. Отправьте весь объект в теле; пропущенные поля могут быть восприняты как пустые. Сгенерированный код отправляет всё тело на точный URL.
PATCH — обновить только указанные вами поля. Тело содержит частичный набор изменений, поэтому сгенерированные запросы меньше, чем PUT, когда вы меняете одно-два значения.
DELETE — удалить ресурс по URL. Он идемпотентен и обычно не имеет тела, поэтому сгенерированный код — простой вызов удаления только с заголовками.
HEAD — запросить только заголовки, без тела ответа. Сгенерированный код похож на GET, но возвращает метаданные, например Content-Length, Last-Modified или Content-Type, экономя трафик.
OPTIONS — выяснить, что сервер разрешает для URL, или имитировать предварительный запрос CORS (preflight). Заголовки ответа (например, Access-Control-Allow-Methods) показывают разрешённые глаголы. У OPTIONS обычно нет тела запроса.
Легко перепутать: HEAD и GET — сгенерированные запросы похожи, но HEAD не возвращает тела. PUT и PATCH — PUT переписывает весь ресурс; PATCH меняет только переданные вами поля.
