Обзор API IO7

IO7 предоставляет трёхуровневую архитектуру API: CoreApi (базовый класс), CrudApi (CRUD-операции) и ApiResult (формирование ответов).

Требования: PHP ^8.2, Illuminate (Laravel 13)

Архитектура

IO\Api\CoreApi          ← базовый класс, жизненный цикл action
        │
        └── IO\Api\CrudApi   ← CRUD-операции (search, create, save, delete)
                │
                └── App\Api\YourApi    ← ваш API

Ключевые классы

CoreApi

Базовый класс для всех API. Реализует паттерн action-методов через магический метод __callStatic().

Жизненный цикл action:

actionGetData($params)
    │
    ├── onBefore()      ← до выполнения
    ├── onInit()        ← инициализация (можно прервать)
    ├── doGetData()     ← основная логика
    └── onAfter()       ← после выполнения

Свойства:

CrudApi

Расширяет CoreApi готовыми CRUD-методами:

ApiResult

Объект для формирования ответов API. Реализует ArrayAccess.

Методы:

Пример showRender:

public function doRender($result, $params)
{
    $result->showRender('@app/example.twig', [
        'name' => 'Alexey',
    ]);
}

Маршрутизация API

API вызываются через IO\Core::callAction() или через HTTP endpoint /entity/:entity.

// Локальный вызов
$result = \IO\Core::callAction('app.model.user.search', [
    'filter' => ['status' => 'active'],
]);

// HTTP вызов
// GET /entity/app.model.user.search?status=active
// POST /entity/app.model.user.search с body: {"filter": {"status": "active"}}

Формат ответа

Все API возвращают массив (или ApiResult, который конвертируется в массив) с полями:

{
    "error_code": 1,
    "error_str": "",
    "items": [...],
    "total": 42
}

Константы ошибок API

См. также

• Создание API
• IO\Core::call() и IO\Core::callAction()
• CRUD операции