re:re:actable
Урок 032 минуты чтения

Чем отличаются params, query и body?

На этой странице
Кратко

params определяют конкретный ресурс в пути, query меняют способ получения списка, а body передаёт данные для создания или изменения.

Вопрос

Чем отличаются params, query и body в Express? Какие данные передавать в каждом из них?

Параметры пути

Запрос:

GET /api/users/42

Маршрут:

app.get("/api/users/:id", (request, response) => {
  const id = Number(request.params.id);
  response.json({ id });
});

request.params.id приходит строкой. Перед использованием его нужно проверить и преобразовать.

Строка запроса

Запрос:

GET /api/users?page=2&limit=20&search=anna
app.get("/api/users", (request, response) => {
  const { page, limit, search } = request.query;
  response.json({ page, limit, search });
});

Строка запроса удобна для:

  • фильтрации;
  • сортировки;
  • поиска;
  • пагинации;
  • выбора дополнительных данных.

Тело запроса

Запрос:

POST /api/users
Content-Type: application/json
 
{
  "name": "Анна",
  "email": "anna@example.com"
}
app.post("/api/users", (request, response) => {
  const { name, email } = request.body;
  response.status(201).json({ name, email });
});

Для JSON до маршрутов должен быть подключён express.json().

Заголовки

Заголовки передают служебные сведения:

const authorization = request.get("authorization");
const contentType = request.get("content-type");

Токен не нужно помещать в строку запроса: адреса часто попадают в историю и журналы.

Где хранить данные

ДанныеМесто
Идентификатор пользователя/users/:id
Номер страницы?page=2
Поисковая строка?search=anna
Имя создаваемого пользователяJSON-тело
Токен доступаЗаголовок или защищённый cookie

Что важно помнить

  • params и query всегда приходят строками — числа нужно преобразовать и проверить.
  • body появляется только после подключения парсера, например express.json().
  • Токены и секреты не передаются в строке запроса: адреса попадают в историю браузера и журналы.
  • Фильтры, сортировка и пагинация — в query; идентификатор ресурса — в params; данные ресурса — в body.

Мини-шпаргалка

  • params — часть пути.
  • query — необязательные настройки запроса.
  • body — данные создаваемого или изменяемого ресурса.
  • Всё пришедшее от клиента нужно проверять.
  • Секреты не передаются в адресе.

Документация

Express: Routing, Express 5: API Reference.

Дочитали до конца?
Отметьте урок — прогресс сохранится в браузере.

Поиск

Поиск по урокам