REST-документация
В модуле поддерживается два вида документации:
В административном разделе.
В публичной части.
Настройка роутов
Каждый конкретный роут можно исключить из необходимой документации. Настраивается такое поведение через карту роутов.
// Пример ключа настройки документации для роута
// ...
'documentation' => [
// Исключить роут
'exclude' => [
// Из документации в административной части сайта
'admin' => false, // true || false
// Из документации в публичной части сайта
'public' => false, // true || false
]
]
// ...
Активация документации в публичной части сайта
Для документации зарезервирован нативный роут: {api_path}/docs
Поэтому, чтобы получить документацию, необходимо либо активировать нативные роуты в настройках модуля, либо скопировать код контроллера в собственный, необходимый контроллер. Код нативного контроллера документации расположен в папке модуля: /lib/controllers/native/documentation.php
Важный момент: документация будет возвращена в json-формате. Такой подход был выбран для того, чтобы было больше гибкости. Например, в таком формате можно передать документацию клиентам, которые отобразят документацию в удобном для себя виде, используя полученные данные.

Last updated