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

Objects ​

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

МетодPathScopeУспех
GET/objects/{name}{name}.read200
GET/objects/{name}/{id}{name}.read200
POST/objects/{name}{name}.create201
PUT / PATCH/objects/{name}/{id}{name}.update200
DELETE/objects/{name}/{id}{name}.delete200

Шаблон фиксирован в 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, ms_categories, orders. Имя categories в core — элементы modCategory. Заказы обычно protected. Подробнее: MiniShop3.

Query и мутации ​

Те же правила querying и mutations, что у resources. Поля и фильтры из определения объекта.

Два отличия от resources:

  • каскадного удаления нет: DELETE трогает одну запись, даже если в объекте есть поле parent
  • правила валидации записей применяются одинаково, но проверки alias, parent, class_key, template, content_type имеют смысл только для ресурсов. Для extras-объектов реальны проверки типов, immutable, hidden и required.