ApiBoot: предназначен для создания API-сервисов с использованием модульной архитектуры

Что такое ApiBoot?

• Русская документация
• Английская документация

ApiBoot — это решение для внедрения API-сервисов, которое предоставляет набор готовых к использованию компонентов, чтобы упростить интеграцию с популярными сторонними фреймворками. Это повышает эффективность работы разработчиков, снижает затраты на обучение и уменьшает порог входа в работу.

Разработчики, имеющие базовое понимание Spring Boot, могут создавать безопасные и стабильные API-сервисы для мобильных приложений, веб-приложений и других конечных точек.

ApiBoot зависит от Spring Boot и может использоваться для создания независимых Java-приложений.

Цели:

• Предоставление решения для интеграции сторонних фреймворков с минимальным порогом входа для Java-разработчиков.
• Готовое к использованию решение, внутренне использующее популярные фреймворки, требующее лишь добавления зависимостей и простого конфигурирования.
• Каждый компонент можно использовать независимо друг от друга, что позволяет избежать избыточности в приложении.
• Быстрое и легкое создание безопасных RESTful API-ресурсов.
• Возможность использования для создания микросервисов на основе Spring Cloud.
• Вклад в развитие открытого программного обеспечения, помогая большему количеству разработчиков.

Установка и начало работы

Использование компонентов следует проверять в официальной справочной документации. Для начала работы переходите к первому приложению ApiBoot.

Если вы используете Maven для сборки проекта, вам потребуется добавить фиксированную версию зависимости ApiBoot в ваш pom.xml, как показано ниже:

<dependencyManagement>
  <dependencies>
    <!-- Зависимость ApiBoot -->
    <dependency>
      <groupId>org.minbox.framework</groupId>
      <artifactId>api-boot-dependencies</artifactId>
      <version>${lastVersion}</version>
      <scope>import</scope>
      <type>pom</type>
    </dependency>
  </dependencies>
</dependencyManagement>

Обратите внимание: lastVersion должно быть заменено на последнюю версию ApiBoot. Посмотреть актуальную версию можно здесь: версия зависимости - 2. Получение последней зависимости ApiBoot.

После добавления зависимости, вы можете добавить необходимые компоненты ApiBoot в свой проект. Пример использования распределённой трассировки minbox-logging представлен ниже:

<dependencies>
  <!-- ApiBoot MinBox Logging -->
  <dependency>
    <groupId>org.minbox.framework</groupId>
    <artifactId>api-boot-starter-logging</artifactId>
  </dependency>
</dependencies>

Добавив компоненты, вы сможете найти соответствующие документы для каждого компонента в официальной справочной документации и начать их использование.

Инструкция по использованию

Авторы предоставляют серию статей для каждого компонента, доступные по ссылке: Сборник статей по использованию различных компонентов ApiBoot.

Получение помощи

Если вы столкнулись с проблемами при использовании ApiBoot, вы можете получить помощь следующими способами:

• Изучите официальную справочную документацию, где все детали использования будут подробно объяснены.
• Отправьте запрос о помощи по адресу https://gitee.com/minbox-projects/api-boot/issues.

Советы по представлению проблемы

Каждый человек может иметь свои уникальные вопросы, но также существуют общие проблемы. Если вы хотите представить свою проблему, следуйте этим рекомендациям:

• Перед тем как представить проблему, проведите поиск среди уже существующих запросов.
• Если ваш вопрос ещё не был представлен, создайте новый запрос.
• При представлении своего вопроса предоставьте максимально возможную информацию о ApiBoot, такой как версия, JDK, используемые компоненты и т.д.
• Если требуется прикрепить код, используйте markdown синтаксис ``` для экранирования.

Конструкция из исходного кода

Официальные версии ApiBoot публикуются в Maven Central. Если вы хотите использовать самую новую версию исходного кода (ещё не выпущенную), вы можете скомпилировать его локально. Нужные условия:

• Настройте переменные окружения Maven, рекомендуется использовать последнюю версию.
• Настройте переменные окружения JDK, скачайте JDK 1.8.
• Настройте переменные окружения Git, скачайте Git.

# Склонировать исходный код master-ветки на локальный компьютер
➜ git clone https://github.com/minbox-projects/api-boot.git
# Перейти в корневой каталог исходного кода api-boot
➜ cd api-boot
# Выполнить установку
➜ mvn clean install -Dmaven.test.skip=true -Dmaven.javadoc.skip=true -Dgpg.skip

Модули

Исходный код ApiBoot состоит из нескольких модулей, вот краткий обзор:

api-boot

Модуль api-boot является корнем всего проекта, он предоставляет следующие возможности:

• Конфигурация единого номера версии revision.
• Использование общего плагина для компиляции (flatten, cobertura...).
• Конфигурация Maven-репозитория для компиляции.
• Единая версия JDK для всех компиляций.Модуль api-boot-autoconfigure является основным ядром, внутри которого находятся автоматически конфигурируемые классы для всех компонентов. Это полностью основано на условиях Spring Boot (условные аннотации). Дополнительные метаданные конфигурации расположены в файлах additional-spring-configuration-metadata.json в директории resources/META-INF.

api-boot-dependencies

Функциональность этого модуля аналогична spring-boot-dependencies. Он используется для закрепления версий зависимостей, что позволяет легко обновлять конкретные зависимости без опасений совместимости между ними.

api-boot-parent

Этот модуль наследует api-boot-dependencies и использует закрепленные версии зависимостей. Он служит родительским модулем для всех остальных модулей.

api-boot-starters

Этот модуль определяет конкретные Starter зависимости, используемые во время разработки. Эти зависимости не содержат никакого кода фреймворков, они представляют собой только файл pom.xml. Автоматическое конфигурирование и интеграция с третьими сторонами реализованы в модулях api-boot-autoconfigure и api-boot-plugins.

Используется так же, как и spring-boot-starter-xxx. Например, для интеграции ограничителя скорости в проект, достаточно добавить зависимость api-boot-starter-rate-limiter в pom.xml, указывать версию не требуется, поскольку она уже закреплена в модуле api-boot-dependencies.

api-boot-tools

Этот модуль определяет некоторые часто используемые утилиты, такие как ApplicationContext, BeanFactory и т.д.

Этот модуль также автоматически конфигурируется через api-boot-autoconfigure, часть утилит регистрируются автоматически в контейнере IoC.

Примеры

Примеры использования различных компонентов находятся в модуле api-boot-samples исходного кода проекта. Подробнее можно узнать из моих статей на сайте: Основные руководства по ApiBoot.

Рекомендованные открытые проекты

Лицензия

ApiBoot создан с использованием лицензии Apache 2.0.

Поддержка открытого ПО