REST API - это способ взаимодействия с Joomla с помощью HTTP-запросов. Им могут пользоваться все: реактивный фронтенд (Angular/Vue/React), мобильные приложения, сторонние интеграции, десктопные приложения и т.д.
OpenApi - формат описания документации по REST API для разработчиков и автоматической генерации. А ныне - самое полезное для ИИ-агентов. В этих файлах описываются схемы данных, обязательные поля, типы обрабатываемых ошибок и их тексты и т.д. В общем, кладезь информации.
Суть проблемы: в Joomla 4 появилось REST API, но подробной документации по нему не было. Была коллекция эндпоинтов и схем данных в Postman от французского Joomla-разработчика Александра Элизи. Но это была частная инициатива (1) и насколько могу судить, не обновлялась какое-то время (2).
Также в разное время возникало несколько самостоятельных инициатив по описанию всех REST методов ядра в формате OpenAPI, но это был ручной труд, не синхронизированный между собой и в итоге все они встали на паузу.
Теперь, в официальной документации manual.joomla.org появится полноценная документация для людей и ИИ-агентов. Протестированная, с примерами PHP кода с использованием HTTP-клиента Joomla (HTTPFactory и curl), с примерами вызовов из js-фронта (Joomla.Request и fetch()).
Также идёт работа над тем, чтобы обновление этой документации было автоматизировано и "источник правды" для неё был один. Для этого заведён отдельный официальный репозиторий, где собственно будет лежать OpenAPI-файл.
Документация manual.joomla.org сделана на Docusaurus. Для красивого вывода информации из OpenAPI осталось настроить плагины и перенести результат с рабочего dev-сайта на основной.
