Универсальный REST

Jmix предоставляет универсальный REST API, который позволяет работать с сущностями модели данных и сервисами бизнес-логики без написания собственных REST-контроллеров на бэкенде. Универсальный REST автоматически предоставляет конечные точки (endpoints) для следующей функциональности:

  • CRUD-операции с сущностями.

  • Вызов зарегистрированных методов сервисов.

  • Выполнение преднастроенных запросов JPQL.

  • Загрузка и выгрузка файлов.

  • Предоставление информации о модели данных.

  • Предоставление информации о текущем пользователе и его правах.

Конечные точки универсального REST можно изучить, используя Swagger UI по адресу https://docs.jmix.io/openapi/2.2

REST API использует протокол OAuth2 для аутентификации и поддерживает также анонимный доступ. Все конечные точки REST API ограничивают доступ к данным в соответствии с настройками подсистемы безопасности.

Дополнение REST API не полностью поддерживает мультиарендность. REST не разделяет экземпляры сущностей по арендаторам.

Установка

Универсальный REST API поставляется как опциональное дополнение. Для его автоматической установки через маркетплейс Jmix обратитесь к инструкции в разделе Дополнения.

Чтобы установить дополнение вручную, добавьте следующие зависимости в ваш build.gradle:

implementation 'io.jmix.authserver:jmix-authserver-starter'
implementation 'io.jmix.rest:jmix-rest-starter'