Документация1С-Битрикс: Модулиnative.apiРазработчикамКарта роутов

Адреса роутов

Адрес роута указывается относительно «Пути интерфейса», без домена и префикса API.

HTTP-методы

Первый уровень карты — HTTP-метод в верхнем регистре. Используйте константы Bitrix\Main\Web\HttpClient: HTTP_GET, HTTP_POST, HTTP_PUT, HTTP_PATCH, HTTP_DELETE, HTTP_HEAD.

Для каждого HTTP-метода нужна отдельная запись в карте.

Формат адреса

Вид	Запись	Сопоставление
Корень API	Пустая строка	Сам «Путь интерфейса»
Статический	`orders/list`	Точное совпадение сегментов
Динамический	`orders/{id}`	Значение сегмента попадает в параметр `id`

Имя параметра внутри фигурных скобок может содержать латинские буквы, цифры и _. Параметр занимает целый сегмент. Необязательные сегменты, маски и регулярные выражения не поддерживаются. Статические сегменты сравниваются с учётом регистра.

Параметры адреса имеют приоритет над строкой запроса и телом. Проверки задаются в карте параметров.

Порядок сопоставления

Поиск выполняется среди роутов HTTP-метода запроса:

Адрес относительно пути API
│
├─ Есть точный статический адрес?
│  └─ Да → выбрать роут
│
└─ Нет → проверить динамические шаблоны
         с тем же числом сегментов
         ├─ Есть совпадение → выбрать роут
         └─ Нет совпадений → HTTP 404

Среди динамических шаблонов приоритет у тех, где фиксированные сегменты расположены ближе к началу пути. Например, orders/{id} имеет приоритет над {section}/{id} при запросе orders/501.