Мини-гайд про виды параметров HTTP (REST API) запросов, в которых чаще всего косячат новички:
👉 query-parameters — после ? в URL.
фильтры, сортировки, пагинация, поисковые строки, api-key (если так принято).
Формат:
GET /products?name=milk&limit=10&offset=20&order=price,asc
Получить список продуктов с названием "milk", 10 записей, начиная с 20-ой, сортировать по возрастанию цены
Типичные проблемы:
• Отправляют бизнес-данные для создания/изменения в query, вместо тела json.
• Дробят сортировку в несколько параметров, вместо одного аккуратного.
• Добавляют query в POST/PUT без причины.
👉 path-parameters — часть пути (эндпоинта).
Идентификатор конкретного ресурса или вложенного ресурса.
Формат:
GET /products/{productId} → GET /products/3a46b…
Можно внутри пути:
PATCH /products/{productId}/archive
Типичные проблемы:
• Отправляют ?productId=… в query, хотя это сущность, а не фильтр.
👉 body-parameters — тело запроса json.
Сообщение, когда создаём/меняем данные.
Только для POST | PUT | PATCH.
Кроме json могут быть другие форматы.
Формат:
{
"name": "Яблоки Гала",
"shortName": "Гала",
"description": "Сладкие и хрустящие"
}
Типичные проблемы:
• Отправляют огромное количество параметров в query-параметры, которые там не помещаются, и могут быть обрезаны сервером при определенных настройках безопасности.
• Используют body (json) для GET или DELETE, где оно не поддержано.
В гайде:
✔️ название параметра и его определение
✔️ скрины из Postman
✔️ особенности
✔️ примеры
Изучайте, запоминайте и не путайтесь 🤝
#RestApiGA