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

Параметр пути — это заполнитель в шаблоне пути конечной точки — /orders/{id} — который клиент заполняет для обращения к конкретному экземпляру. В отличие от параметра запроса, он является частью идентификатора ресурса: /orders/42 и /orders/43 — это разные ресурсы, а /orders ?status=open — это представление одного из них.

Как это работает

Сервер сопоставляет путь со своими шаблонами, извлекает сегмент и проверяет его: нечисловой идентификатор там, где ожидается число, должен быть 400, а корректный идентификатор без каких-либо данных — 404. Значения должны быть закодированы в процентах — косая черта внутри значения разделит путь на разные маршруты.

Заблуждение

Ошибка 404 всегда означает опечатку в URL. В случае параметра пути это чаще означает, что ресурс был удален, никогда не существовал или существует, но вызывающая сторона может об этом не знать — некоторые API намеренно отвечают 404 вместо 403, чтобы не проверять подлинность идентификатора.

Попробуйте здесь.

Любой API принимает идентификаторы в пути. API Voxel Worlds принимает сразу три идентификатора по запросу GET /voxel/v1/worlds/{id}/blocks/{x}/{y}/{z} , а API Чемпионата мира по футболу использует букву вместо числа по запросу GET /worldcup/v1/groups/{letter}/standings.

Источники

Другие термины

Читать страницу на английском

Все термины · Приёмы тестирования · Все 39 mock REST API

Последнее обновление