mxHeadless
REST API gateway для headless-фронтендов на MODX 3. Ресурсы, объекты, OpenAPI, API keys и OAuth
Быстрый старт
1. Установить пакет
Через modstore.pro (провайдер https://modstore.pro/extras/, email и API-ключ из ЛК) найдите и установите mxHeadless. Либо соберите transport:
bash
cd _build
php build.phpВ Manager: Пакеты → Установить пакет → загрузите .transport.zip.
Очистите кэш MODX. Подробнее: Установка.
2. ЧПУ и веб-сервер
Включите friendly URLs. Запросы /api/v1/* должны попадать в index.php MODX. Правила: Веб-сервер.
Без rewrite:
bash
curl -s 'https://your-site.example/assets/components/mxheadless/api.php?route=/v1/health'3. Проверить gateway
bash
curl -s https://your-site.example/api/v1 | jq
curl -s https://your-site.example/api/v1/health | jqDiscovery возвращает версию пакета и снимок capabilities. Health проверяет подключение к БД.
4. Список ресурсов
bash
curl -s 'https://your-site.example/api/v1/resources?limit=5&filter[published]=1' | jqПубличное чтение resources и pages работает без ключа. Элементы, контексты и большинство objects требуют аутентификации.
5. Swagger и OpenAPI
Откройте в браузере /api/v1/docs или скачайте spec с /api/v1/meta/openapi.json. Подробнее: Swagger и OpenAPI.
6. Ключ для защищённых маршрутов
В Manager: Компоненты → mxHeadless (нужно право mxheadless_apikeys) или CLI:
bash
php core/components/mxheadless/bin/api-key-create.php --name=ci --scopes=resources.read,chunks.readSecret показывают один раз. Дальше:
bash
curl -s https://your-site.example/api/v1/chunks \
-H 'Authorization: Bearer mxh_...'