Skip to content
mxHeadless
REST API gateway для headless-фронтендов на MODX 3. Ресурсы, объекты, OpenAPI, API keys и OAuth
  1. Компоненты
  2. mxHeadless
  3. Начало работы
  4. Веб-сервер

Веб-сервер

Префикс gateway по умолчанию /api (mxheadless_api_prefix). Запросы /api/v1/* должны попадать в index.php MODX, где плагин OnHandleRequest перехватывает API.

Apache

Включите mod_rewrite. Friendly URLs MODX уже направляют неизвестные пути в index.php. Отдельный rewrite-блок для /api обычно не нужен.

Nginx

nginx
location / {
    try_files $uri $uri/ /index.php?$args;
}

Путь /api/v1/* не должен отдаваться статикой и не должен обходить PHP.

Резервный вход

Без rewrite используйте assets/components/mxheadless/api.php.

  • С PATH_INFO: .../api.php/v1/health
  • Без PATH_INFO (типичный nginx/Herd): .../api.php?route=/v1/health

Голый api.php отдаёт discovery. См. Установку.

Прокси и HTTPS

За load balancer заполните mxheadless_trusted_proxies, иначе rate limit и audit видят IP прокси. Пакет не подменяет схему URL из X-Forwarded-Proto. HTTPS настраивайте на веб-сервере или reverse proxy.