Особенности версии
native.api продолжает развитие artamonov.rest, впервые опубликованного в 2018 году. В таблице — отличия от предыдущего модуля.
Что изменилось
| Возможность | artamonov.rest | native.api |
|---|---|---|
| Запуск API | Для работы с текущим пользователем требовалось самостоятельно подключать классы и модули | Сервис подключает ядро Битрикса; пользователь доступен через контекст API |
| Клиенты пользователя | Один токен на пользователя | Несколько клиентских сессий с отдельными парами токенов |
| Обновление доступа | Управление одним токеном и его сроком действия | Пары access/refresh-токенов с раздельными сроками и ротацией |
| Отзыв доступа | Удаление общего токена пользователя | Отзыв выбранной клиентской сессии без отключения остальных |
| Хранение токенов | Исходный токен в поле пользователя | Хеши токенов вместо исходных значений |
| Подготовка роутов | Карты загружаются при обработке запроса | Скомпилированные карты кешируются и используются повторно |
| Событийная модель | Расширение логики через собственные контроллеры | Пользовательские обработчики до и после основных этапов запроса и операций с токенами |
| Пути API и документации | Выбор API по первому сегменту пути | Независимые вложенные пути API и документации с автоматическим обновлением точек входа |
| Документация | Описание роутов в админке и JSON-описание для клиента | OpenAPI и готовая интерактивная документация с выполнением запросов |
| Видимость документации | Настройки включения роута в административное и публичное описание | Доступ к документации и набору роутов по группам пользователей |
| Журналирование | Журналы запросов, ответов и лимитов в базе | История с карточкой запроса; данные запросов и ответов в базе и файлах; аудит событий; независимая настройка записи |
| Рабочее пространство | Административные страницы модуля | Дашборд с собственными и настраиваемыми гаджетами |
Обновление до версии 2.2.0
При обновлении карты роутов и собственного PHP-кода:
- замените ключ
technical_keys_disabledнаkeys_technical_disabled, константуResponseConfig::TECHNICAL_KEYS_DISABLED— наResponseConfig::KEYS_TECHNICAL_DISABLED; - используйте
OptionConfig::ROUTE_KEYS_TECHNICAL_DISABLEDи методisRouteKeysTechnicalDisabled()вместо прежних имён; - если флажок «Отключить технические ключи ответа» был включён, включите его заново на вкладке «Роуты»;
- очистите кеш API-платформы.
Обновление до версии 2.0.0
Версия 2.0.0 добавила интеграцию отдельного native.mcp.
При обновлении собственного PHP-кода:
- замените
ApiExceptionнаNative\Api\Exceptions\ExceptionApiв импортах, типах и catch; - используйте ModuleApi::getName()/ModuleMcp::getName() вместо удалённой константы MODULE_NAME;
- используйте текущие имена флагов и методов настроек, сохраняя строковые ключи опций;
- для разных контекстов используйте псевдонимы ContextApi, ContextMcp и ContextBitrix, не переименовывая собственный класс Context;
- секцию публикации роута как инструмента MCP описывайте константами ToolConfig вместо строковых ключей;
- очистите кеш API-платформы после изменения карты или обновления её формата.
Обработчик controller — класс/метод, invokable-класс или PHP-скрипт. Анонимные controller в контракт версии не входят.