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

Подключение карты

Карта роутов — PHP-файл, возвращающий через return массив роутов, сгруппированных по HTTP-методам.

Подключение

  1. Разместите файл карты внутри сайта, вне каталога модуля.
  2. Откройте «Сервисы → API-платформа → Настройки модуля», вкладку «Основные».
  3. В поле «Путь карты роутов» укажите путь к файлу относительно корня сайта.
  4. Нажмите «Сохранить».

Файл должен существовать и быть доступен PHP для чтения. В пути не допускаются пробелы, обратные косые черты и сегменты . или ...

Для отключения карты очистите поле «Путь карты роутов» и сохраните настройки.

Настройка роутов

Переопределение роутов

Пользовательская карта дополняет встроенные роуты. При совпадении HTTP-метода и адреса описание из пользовательской карты полностью заменяет встроенное, включая настройки безопасности.

Встроенная карта
      ↓
Пользовательская карта
├─ Новый метод или адрес → добавить роут
└─ Совпали метод и адрес → заменить роут целиком
      ↓
Исключить отключённые наборы роутов
      ↓
Скомпилировать карту и сохранить в кеш

Наборы native, provider и service включаются в настройках роутов. Эта схема описывает сборку карты; порядок поиска конкретного роута — в разделе «Адреса роутов».

Свои настройки

Помимо ключей модуля, в описание каждого роута можно добавлять любые собственные настройки, включая вложенные массивы.

В контроллере получите настройки текущего роута:

<?php

$config = \Native\Api\Context::getCurrent()
    ->getRoute()
    ->getConfig()
    ->toArray();

Обновление карты

После обновления карты роутов требуется очистка кеша модуля. При сохранении изменённого пути кеш очищается автоматически.