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

Objects

Универсальный CRUD для объектов из ObjectRegistry. Имя в URL, logical name (products, orders), не PHP-класс.

MethodPathScope
GET/objects/{name}{name}.read
GET/objects/{name}/{id}{name}.read
POST/objects/{name}{name}.create
PUT / PATCH/objects/{name}/{id}{name}.update
DELETE/objects/{name}/{id}{name}.delete

Паттерн фиксирован в RoutesRegistrar: {name}.{action}. Не objects.{name}.read.

bash
curl -s 'https://example.com/api/v1/objects/products?limit=10' \
  -H 'Authorization: Bearer mxh_...'

Registry

Объект появляется в API только после регистрации через core bootstrap или событие OnMxHeadlessRegister. См. Расширение.

Незарегистрированное имя возвращает 404.

MiniShop3

Типичные имена: products, categories, orders, … Заказы обычно protected. Подробнее: MiniShop3.

Query и мутации

Те же правила querying и mutations, что у resources, в пределах fields/filters definition.