docs.modx.pro
  1. Компоненты
  2. mxHeadless
  3. API
  4. Discovery

Discovery ​

GET /api/v1 отдаёт базовые метаданные API. По нему проверяют шлюз и версию перед подключением фронта или CI.

Аутентификация не нужна. Работает и при kill switch (вместе с /health).

bash
curl -s https://your-site.example/api/v1 | jq

Префикс задаёт mxheadless_api_prefix (по умолчанию /api). Сегмент v1 зашит в роутер.

Ответ ​

json
{
  "data": {
    "name": "mxHeadless",
    "version": "1.0.43",
    "api": "/api/v1",
    "cors": {
      "enabled": false,
      "allowed_origins": []
    },
    "links": {
      "health": "/api/v1/health",
      "schema": "/api/v1/schema",
      "docs": "/api/v1/docs",
      "endpoints": "/api/v1/meta/endpoints",
      "openapi": "/api/v1/meta/openapi",
      "openapi_json": "/api/v1/meta/openapi.json",
      "auth_token": "/api/v1/auth/token",
      "resources": "/api/v1/resources",
      "pages": "/api/v1/pages/{uri}",
      "contexts": "/api/v1/contexts",
      "chunks": "/api/v1/chunks",
      "templates": "/api/v1/templates",
      "snippets": "/api/v1/snippets",
      "tvs": "/api/v1/tvs",
      "categories": "/api/v1/categories",
      "content_types": "/api/v1/content_types",
      "objects": "/api/v1/objects/{name}"
    }
  },
  "meta": {}
}
ПолеСмысл
versionВерсия пакета на сайте
corsВключение CORS и снимок origin
linksПубличные URL meta и content API

Discovery не перечисляет все маршруты. Полный список: GET /meta/endpoints. Формы параметров: Swagger и OpenAPI или /schema.

Когда вызывать ​

  • Мониторинг «API жив»
  • Скрипты сборки клиентов
  • Первая проверка после установки

См. также ​