Open Api

Модуль BPM2B Open Api автоматически собирает OpenAPI 3.1.1 спецификацию для платформы BPM2B из metadata установленных модулей. Внешние клиенты, фронтенды и интеграции получают актуальную, машиночитаемую документацию по API без отдельного процесса сопровождения — обновил metadata, перегенерировался YAML-контракт.

Основные функциональные возможности:

• Provider — главный сборщик: собирает schemas (из entityDefs / fieldDefs), CRUD-пути (из scopes / aclActionList), link-пути (из relationDefs) и кастомные роуты; результат кешируется в DataCache.
• RouteProcessor — три уровня обработки роутов: Level 1 (auto) — без аннотаций, базовый path item; Level 2 (declarative) — ключ openApi в routes.json; Level 3 (dynamic) — PHP-класс через openApiGenerator.
• FieldSchemaBuilderFactory: резолв стратегии в три шага — metadata app.openApi.fieldSchemaBuilderClassNameMap (точка расширения модулями) → встроенный TYPE_MAP на 30 типов полей → auto-detect compound-полей через actualFields.
• Единый apiSpecDisabled: исключение из спецификации на четырёх уровнях — сущность (scopes.{Entity}), поле (entityDefs.{Entity}.fields.{field}), связь (entityDefs.{Entity}.links.{link}), роут (routes.json).
• CRUD и link-пути: для каждой сущности генерируются стандартные create / read / update / delete / list, плюс отдельные пути на каждую связь — list / relate / unrelate.
• Swagger UI: статический HTML по адресу {siteUrl}/swagger/index.html; требует cookie-авторизации платформы; spec URL — /api/v1/bpm2bOpenApi/spec.
• Расширяемость без правки кода: новый тип поля → свой FieldSchemaBuilder в metadata; нестандартный endpoint → ключ openApi или openApiGenerator в routes.json; модуль никаких пакетов не требует изменения.

Модуль предназначен для платформ с большим числом интеграций и внешних потребителей API. Зависимостей нет — работает на голой инсталляции и автоматически обнаруживает все установленные модули, включая совместимый bpm2bQazaq с compound-полями (varchar-kz, text-kz).