ApiBoot 文档

快速开始

ApiBoot是一系列的第三方服务依赖,基础的项目还是采用SpringBoot方式进行构建,集成ApiBoot步骤如下

1. 创建SpringBoot项目

创建SpringBoot项目有多种,简单介绍两种方式:

  • https://start.spring.io/
  • idea开发工具创建Spring Initializr项目
  • ...

2. 添加ApiBoot版本控制

SpringBoot项目创建完成我们需要添加ApiBoot的版本控制,这样我们就可以像SpringBootSpringCloud在添加依赖时不用配置version,有利于我们做版本统一维护。

ApiBoot版本依赖需要添加在pom.xml配置文件内,如下所示:

<!--ApiBoot 版本依赖-->
<dependencyManagement>
  <dependencies>
    <dependency>
      <groupId>org.minbox.framework</groupId>
      <artifactId>api-boot-dependencies</artifactId>
      <version>{lastVersion}</version>
      <scope>import</scope>
      <type>pom</type>
    </dependency>
  </dependencies>
</dependencyManagement>

可以从Maven Centerl查询最新的ApiBoot版本来替换{lastVersion}

查询地址:https://search.maven.org/search?q=a:api-boot-dependencies

到这里我们就已经完成了ApiBoot的基础集成,是不是特别简单?

3. 开箱即用

那接下来就根据具体的需求来选择使用ApiBoot提供的封装依赖了,比如你需要集成swagger文档,那么就可以添加如下依赖到pom.xml文件内:

<dependencies>
  <dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
  </dependency>
  <!--ApiBoot Swagger-->
  <dependency>
    <groupId>org.minbox.framework</groupId>
    <artifactId>api-boot-starter-swagger</artifactId>
  </dependency>
  <dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-test</artifactId>
    <scope>test</scope>
  </dependency>
</dependencies>

依赖添加完成后根据具体的组件使用文档来进行配置参数以及接口实现等。

详情参考左侧菜单集成组件