1 Star 0 Fork 420

singmoonshell / api-boot

forked from minbox-projects / api-boot 
加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

ApiBoot:为组件化构建Api服务而生

Ci Builder

什么是ApiBoot?

ApiBoot是接口服务的落地解决方案,提供了一系列开箱即用的组件,通过封装来简化主流第三方框架的集成,从而提高开发者开发效率、学习成本、降低入门门槛,真正的实现开箱即用!!!

对SpringBoot简单了解的开发者就可以编写安全稳定的接口服务,可为移动端、网页端等多个端点提供丰富的安全接口。

ApiBoot依赖于SpringBoot,可以使用ApiBoot构建独立的Java应用程序。

愿景:

  • 为Java开发者提供低门槛第三方框架集成解决方案,让复杂的框架集成使用的门槛更低。
  • 开箱即用,内部封装了主流框架,只需添加依赖、简单配置即可使用。
  • 各个组件可独立使用,不再冗余你的应用程序。
  • 可简单快速的构建安全的restful资源接口服务。
  • 可用于构建SpringCloud微服务服务实例。
  • 为🇨🇳开源做贡献,希望开源框架可以帮助更多的开发者。

安装 & 入门

组件的使用请查看官方参考文档,开始使用请访问第一个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的过程中遇到了问题,你可以通过以下途径获取帮助!

提交问题建议

每个人可能提出的问题不同,不过也会有一些相同的问题,如果您要提出问题,请遵循以下建议:

  • 在提交问题之前,请搜索issues内是否已经有人提出过该问题。
  • 如果您即将要提出的问题不存在,请创建issue
  • 请在提出您的问题时提供尽可能有关ApiBoot可能多的信息,比如:ApiBoot的版本、JDK、使用组件等
  • 如果提问题时需要粘贴代码,请尽量使用markdown语法```转义符。

源码方式构建

ApiBoot正式版本都会发布到Maven Center,如果你想使用源码最新版本的ApiBoot(版本并未发布),可以直接通过源码的方式进行构建安装到本地使用,前提条件如下所示:

# 下载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的配置
  • 提供项目编译时使用的公共插件(flattencobertura...)
  • 提供项目编译时使用的Maven仓库配置
  • 统一项目编译的JDK版本

api-boot-autoconfigure

api-boot-autoconfigure是最为主要的核心模块,内部提供了全部组件自动化配置类,这一点完全是利用SpringBoot所提供的条件判断注解,位于resources/META-INF目录下还提供了附加的配置参数元数据定义内容文件:additional-spring-configuration-metadata.json,项目启用时我们所看到的banner输出内容也位于该模块中。

api-boot-dependencies

该模块的功能与spring-boot-dependencies一致,都是为了固化项目中所使用的依赖版本号,让我们在构建项目中可以很好地对某一个依赖进行升级,不再担心各个依赖之间版本不兼容的困扰。

api-boot-parent

该模块继承自api-boot-dependencies,可直接使用固化版本后的依赖,是构建其他模块的统一父依赖。

api-boot-starters

该模块下定义了开发过程中具体使用的Starter依赖,Starter依赖内不包含任何的框架代码,只有一个pom.xml文件,具体的自动化配置实现以及具体集成第三方的实现分别位于:api-boot-autoconfigureapi-boot-plugins模块内。

使用方式与spring-boot-starter-xxx一致,比如:在项目中集成限流组件,我们只需要在pom.xml中添加api-boot-starter-rate-limiter依赖即可,版本也无需添加,因为已经通过api-boot-dependencies模块进行了固化版本依赖。

api-boot-tools

该模块会定义一些常用到的工具类,比如:ApplicationContextBeanFactory等。

该模块同样是由api-boot-autoconfigure进行自动化配置,将部分工具类自动注册到IOC

示例

项目源码中api-boot-samples模块提供了各个组件的使用示例,也可以结合我博客文章来学习使用,详情请访问:ApiBoot基础教程

推荐开源项目

项目名称 作者 项目地址
分布式链路日志开源框架 恒宇少年 https://gitee.com/minbox-projects/minbox-logging
SpringBoot_v2 bdj https://gitee.com/bdj/SpringBoot_v2
Pear Admin Layui 就眠仪式 https://gitee.com/Jmysy/Pear-Admin-Layui

License

ApiBoot采用Apache2开源许可进行编写。

开源支持

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.

简介

ApiBoot为接口服务而生,基于SpringBoot完成扩展、自动化配置,通过封装一系列Starter来让调用者快速集成组件,降低学习、使用门槛,提高开发效率,点击右上角Star关注项目更新。 展开 收起
Java
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
Java
1
https://gitee.com/singmoonshell/api-boot.git
git@gitee.com:singmoonshell/api-boot.git
singmoonshell
api-boot
api-boot
2.3.x

搜索帮助

14c37bed 8189591 565d56ea 8189591