4.7.1.1. Включение в проект

REST API включен в качестве зависимости в модули web и portal базового проекта cuba. По умолчанию, он запускается в модуле portal и не запускается в модуле web. Поэтому, если вам нужен REST API, у вас есть две возможности:

  • Создать модуль portal в проекте приложения. Откройте проект в CUBA Studio и нажмите Create portal module в панели Project properties навигатора. После этого функции REST API будут доступны по адресу {host:port}/app-portal/api.

  • Запустить REST API в модуле web. Откройте проект в CUBA Studio и перейдите Project properties > Edit > Advanced, затем выберите флажок REST API in web module. После этого функции REST API будут доступны по адресу {host:port}/app/dispatch/api.

Контроллеры REST API регистрируются в контексте Spring, определяемом файлом portal-dispather-spring.xml соответствующего модуля (portal-dispatcher-spring.xml or web-dispatcher-spring.xml):

<context:component-scan base-package="com.haulmont.cuba.restapi"/>