ApiBoot Admin

基于新一代接口服务框架 “ApiBoot” 的前后分离管理平台基础解决方案脚手架示例。

• 猛戳查看ApiBoot组件系列化文章教程
• ApiBoot源码仓库

I. 诞生

为了给ApiBoot使用者演示各个组件整合使用，因此ApiBoot Admin诞生了！！！

因为ApiBoot是由Java编写的纯后端组件化基础框架，为了结合实际中的开发场景，所以将vue-element-admin集成到了ApiBoot Admin中作为前端的展示，从而打造了一个简单的前后端分离的演示环境。

友情提示：可以将admin-services项目从ApiBoot Admin独立出来作为一个接口服务，由于内部提供了一些常用的常量、基础的统一配置等等，完全可以在其基础上进行二次开发。

II. 源码目录

ApiBoot Admin是一个前后分离的演示项目。

1. 接口部分 (admin-services)

接口为后台的前端框架提供数据的支持，完全使用ApiBoot内提供的组件进行编写，使用的组件如下一览（点击直接把你送到组件的官方文档）：

• ApiBoot OAuth
• ApiBoot Security
• ApiBoot Logging
• ApiBoot Logging Admin
• ApiBoot MyBatis Enhance
• ApiBoot MyBatis Enhance Codegen
• ApiBoot MyBatis Pageable
• ApiBoot Swagger
• ApiBoot DataSource Switch
• ApiBoot Resource Load
• ApiBoot Rate Limiter
• ApiBoot Quartz
• ApiBoot Aliyun Mail
• ApiBoot Aliyun OSS
• ApiBoot Aliyun SMS
• ApiBoot Message Push

2. 前端部分 (admin-ui)

前端采用 花裤衩 提供的vue-element-admin整合框架，详细使用请访问vue-element-admin官方文档。

日志服务端 (admin-log-server)

基于ApiBoot Logging Admin组件构建，用来采集接口服务（admin-services）所产生的全部日志信息并记录到数据库内（请求日志、链路日志、全局日志）。

III. 运行环境

• JDK 1.8+
• MySQL 5.5+
• NodeJs 10.18.0
• Npm 6.13.4

IV. 本地运行

1. 创建数据库

请复制仓库内的 api-boot-admin.sql 脚本内容在本地自行创建数据库。

2. 下载源码

git clone git@gitee.com:minbox-projects/api-boot-admin.git

3. 编译项目

# 进入api-boot-admin目录
➜  cd api-boot-admin
# 在api-boot-admin根目录打包项目
➜  api-boot-admin git:(master) ✗ mvn clean package

4. 启动日志服务

➜  api-boot-admin git:(master) ✗ cd admin-log-server 
➜  admin-log-server git:(master) ✗ java -jar target/admin-log-server-0.1.0.RELEASE.jar

5. 启动接口

➜  api-boot-admin git:(master) ✗ cd admin-services 
➜  admin-services git:(master) ✗ java -jar target/admin-services-0.1.0.RELEASE.jar 

6. 运行后台

➜  api-boot-admin git:(master) ✗ cd admin-ui 
# 安装npm依赖包
➜  admin-ui git:(master) ✗ npm install
# 运行开发环境
➜  admin-ui git:(master) ✗ npm run dev

后台成功启动后，访问 http://localhost:9527/ 可看到如下界面：

在api-boot-admin.sql数据库脚本中有登录的用户信息。

用户名：hengboy，密码：123456

首页只是图表组件示例，如需动态读取数据可以了解vue-element-admin。

该模块内的功能是已经完善的，用到的接口都在admin-services/org.minbox.framework.api.boot.admin.api.SystemUserApi控制器内，查看源码可了解ApiBoot各个组件的使用方式。

V. 接口文档

ApiBoot Admin内部通过集成ApiBoot Swagger来实现接口文档的自动生成。

访问地址：http://localhost:9090/swagger-ui.html。

在接口Api类内的方法上简单的配置Swagger2所提供的注解就可以实现文档的自动生成，支持在线调试，还支持设置OAuth2所生成的请求令牌调试接口。