Шаблон (архетип) REST приложения

В этой теме рассматривается создание REST приложения из шаблона версии avalanche-rs-archetype 2.x для спецификации сервлетов 5.0 (jakarta.servlet) и выше и JVM 11 и выше.

При требованиях к разрабатываемому приложению JVM 1.8 и спецификации сервлетов до 4.0 включительно (javax.servlet) следует выбрать версию avalanche-rs-archetype 1.x.

В результате генерации REST приложения из шаблона получается работоспособное приложение. Шаблон REST приложение основан на Java библиотеках jersey с интерфейсом swagger-ui.

Создать REST приложение из шаблона (архетипа)

Вызовете меню Eclipse IDE File -> New - Project..., раскройте ветку Maven, выбрать Maven Project и нажать в этом и следующем окне кнопки Next.

Maven проект

Выбор архетипа

Полный список архетипов очень большой и потребуется некоторое время на его загрузку. Для уменьшения списка архетипов можно раскрыть список репозиториев в поле Catalog и выбрать ранее введенный каталог Архетипы Avalanche или ввести слово avalanche в поле Filter.

После отображения списка архетипов Avalanche выбрать архетип avalanche-rs-archetype 2.0.1 и нажать кнопку Next.

Выбор архетипа

Определение параметров проекта

В следующем окне необходимо ввести параметры проекта. Задать идентификатор группы в поле Group Id, идентификатор артефакта в поле Artefact Id, версию проекта или оставить значение по умолчанию в поле Version.

Обязательно снять галку в поле run archetype generation interactive. Если эту галку не снять, то потребуется отвечать на вопросы в процессе генерации проекта из шаблона.

Ниже нужно определить параметр приложения имя базы данных (databaseName) и тестовый запрос в БД (sql, по умолчанию определен тестовый запрос для СУБД Postgres).

Параметры проекта

После ввода всех значений нажать кнопку Finish и дождаться окончания процесса генерации проекта из шаблона (ахретипа).

Если галку в поле run archetype generation interactive по какой либо причине не сняли, то в представлении Console среды разработки Eclipse потребуется отвечать на вопросы.

Созданный проект

Созданный проект

Раскройте созданный проект rs и откройте файл README.md, в котором описан процесс запуска созданного приложения в среде Eclipse IDE и на других узлах.

В проекте приведен пример простого REST сервиса.

Пример интерфейса приложения

Вид интерфейса пользователя при запуске приложения.

Пример интерфейса приложения

Примеры ресурсов REST приложения

  1. Пример конфигурационного файла приложения
  2. Пример конфигурационного файла log4j
  3. Пример конфигурации контекста WEB сервера Tomcat
  4. Пример реализации класса сервиса Service.java