18 Star 172 Fork 62

minbox-projects / api-boot-admin

Create your Gitee Account
Explore and code with more than 12 million developers,Free private repositories !:)
Sign up
Clone or Download
contribute
Sync branch
Cancel
Notice: Creating folder will generate an empty file .keep, because not support in Git
Loading...
README
Apache-2.0

ApiBoot Admin

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

I. 诞生

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

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

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

II. 源码目录

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

1. 接口部分 (admin-services)

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

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所生成的请求令牌调试接口。

Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

About

基于新一代接口服务框架 “ApiBoot” 的前后分离管理平台基础解决方案脚手架示例 expand collapse
Java and 6 more languages
Apache-2.0
Cancel

Releases

No release

Contributors

All

Activities

Load More
can not load any more
Java
1
https://gitee.com/minbox-projects/api-boot-admin.git
git@gitee.com:minbox-projects/api-boot-admin.git
minbox-projects
api-boot-admin
api-boot-admin
master

Search