Сервисные роуты

Сервисные роуты проверяют обработку запросов и разные типы контроллеров. Все операции диагностические: данные пользователей, групп и других сущностей не изменяются.

Включите их в настройках роутов. Адреса ниже указаны относительно пути интерфейса API.

GET up

Базовая проверка доступности API и вызова метода контроллера. Можно передать произвольные параметры в строке запроса.

Переданные значения возвращаются в поле parameters. Пример запроса

GET up/user/{id}

Проверяет передачу параметра в адресе роута. Значение {id} попадает в parameters.id вместе с остальными параметрами запроса.

Пример запроса с ID и строкой запроса

GET up/group/{id}

Показывает настройку доступа по системной группе администраторов.

Роут виден администраторам в документации. В его карте не задана авторизация API, поэтому запрос проверяется как анонимный и не проходит whitelist.

Пример проверки ограничения

POST up

Проверяет передачу тела запроса и вызов метода create(). Принятые параметры возвращаются в parameters.

Пример передачи JSON

PUT up

Проверяет выполнение PHP-файла как контроллера и формирование XML-ответа.

Пример запроса и получения XML

DELETE up

Проверяет выполнение вызываемого класса через __invoke().

Контроллер явно задаёт статус 200, поэтому диагностические данные передаются в теле ответа. Пример запроса

Данные ответа

Успешный вызов возвращает:

Расположение данных зависит от технической обёртки. В PUT данные находятся внутри корневого элемента response.

Формат ответа можно изменить параметром format=json или format=xml в строке запроса.