Skip to content

Commit c9341c3

Browse files
hengboyhengboy
committed
文档1.x分支路径修改.
1 parent 3f18cf0 commit c9341c3

File tree

8 files changed

+29
-29
lines changed

8 files changed

+29
-29
lines changed

‎README.md‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11

22
# ApiBoot
3-
[![Maven Central](https://img.shields.io/maven-central/v/org.minbox.framework/api-boot.svg?label=Maven%20Central)](https://search.maven.org/search?q=g:%22org.minbox.framework%22%20AND%20a:%22api-boot%22) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/weibocom/motan/blob/master/LICENSE) ![](https://img.shields.io/badge/JDK-1.8+-green.svg) ![](https://img.shields.io/badge/SpringBoot-1.5+_2.0+-green.svg)
3+
[![Maven Central](https://img.shields.io/maven-central/v/org.minbox.framework/api-boot.svg?label=Maven%20Central)](https://search.maven.org/search?q=g:%22org.minbox.framework%22%20AND%20a:%22api-boot%22) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/weibocom/motan/blob/1.x/LICENSE) ![](https://img.shields.io/badge/JDK-1.8+-green.svg) ![](https://img.shields.io/badge/SpringBoot-1.5+_2.0+-green.svg)
44

55
`ApiBoot`是一款基于`SpringBoot2.x`的接口服务集成基础框架，内部提供了框架的封装集成，让接口开发者完成开箱即用，不再为搭建接口框架而犯愁，从而极大的提高开发效率。
66
通过在我的`SpringBoot`系列教程中得到的学习者的反馈，才决定来封装一套对应我文章的基础框架，`ApiBoot`内的每一个框架的具体讲解都在文章内进行了详细说明，如果有不明白的可以通过如下途径访问我的文章：
@@ -21,7 +21,7 @@
2121
- **阿里云OSS资源处理**：集成阿里云OSS提供的SDK来完成文件的上传、下载等方法实现，开箱即用。
2222
- **阿里云短信**：集成阿里云提供的SMS服务，简单配置即可完成短信发送，覆盖全球的短信服务，友好、高效、智能的互联化通讯能力，帮助企业迅速搭建客户触达通道。
2323

24-
更多功能请参考 [更多功能列表](https://github.com/hengboy/api-boot/tree/master/api-boot-project/api-boot-starters)
24+
更多功能请参考 [更多功能列表](https://github.com/hengboy/api-boot/tree/1.x/api-boot-project/api-boot-starters)
2525

2626
## 组件
2727

@@ -33,7 +33,7 @@
3333
- **[Mybatis Pageable](https://github.com/hengboy/mybatis-pageable)**：`MyBatis-Pageable`是一款自动化分页的插件，基于`MyBatis`内部的插件`Interceptor`拦截器编写完成，拦截`Executor.query`的两个重载方法计算出分页的信息以及根据配置的数据库`Dialect`自动执行不同的查询语句完成总数量的统计。
3434
- **[Code Builder](https://github.com/hengboy/code-builder)**：`code-builder`是一款代码生成`maven mojo`插件，通过简单的配置就可以完成数据库内`Table`转换`Entity`或者其他实体类，想怎么生成完全根据你的个人业务逻辑，`code-builder`尽可能的完善的提供数据库内的一些定义的信息，让你更方便更灵活的来生成`Java`文件。
3535

36-
更多组件请参考[更多集成组件](https://github.com/hengboy/api-boot/tree/master/api-boot-project/api-boot-starters)
36+
更多组件请参考[更多集成组件](https://github.com/hengboy/api-boot/tree/1.x/api-boot-project/api-boot-starters)
3737

3838
## 怎么使用？
3939

@@ -65,11 +65,11 @@
6565

6666
Demo列表：
6767

68-
- [ApiBoot Security Oauth](https://github.com/hengboy/api-boot/tree/master/api-boot-samples/api-boot-sample-security-oauth-jwt)
69-
- [ApiBoot Swagger](https://github.com/hengboy/api-boot/tree/master/api-boot-samples/api-boot-sample-swagger)
70-
- [ApiBoot Http Converter](https://github.com/hengboy/api-boot/tree/master/api-boot-samples/api-boot-sample-http-converter)
71-
- [ApiBoot Alibaba OSS](https://github.com/hengboy/api-boot/tree/master/api-boot-samples/api-boot-sample-alibaba-oss)
72-
- [ApiBoot Alibaba SMS](https://github.com/hengboy/api-boot/tree/master/api-boot-samples/api-boot-sample-alibaba-sms)
68+
- [ApiBoot Security Oauth](https://github.com/hengboy/api-boot/tree/1.x/api-boot-samples/api-boot-sample-security-oauth-jwt)
69+
- [ApiBoot Swagger](https://github.com/hengboy/api-boot/tree/1.x/api-boot-samples/api-boot-sample-swagger)
70+
- [ApiBoot Http Converter](https://github.com/hengboy/api-boot/tree/1.x/api-boot-samples/api-boot-sample-http-converter)
71+
- [ApiBoot Alibaba OSS](https://github.com/hengboy/api-boot/tree/1.x/api-boot-samples/api-boot-sample-alibaba-oss)
72+
- [ApiBoot Alibaba SMS](https://github.com/hengboy/api-boot/tree/1.x/api-boot-samples/api-boot-sample-alibaba-sms)
7373

7474
## 版本管理规范
7575

@@ -94,7 +94,7 @@ yuqiyu999
9494

9595
#### 钉钉群
9696

97-
![](https://github.com/hengboy/api-boot/blob/master/dingding_group.JPG)
97+
![](https://github.com/hengboy/api-boot/blob/1.x/dingding_group.JPG)
9898

9999
### 项目结构
100100

‎api-boot-project/api-boot-starters/README.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@ ApiBoot`提供的所有封装依赖对应第三方框架关系如下所示：
55
| 依赖名称 | 介绍 |
66
| ------------------------------------------------------------ | -------------------------------------------- |
77
| api-boot-starter | 所有Starter的基础依赖 |
8-
| [api-boot-starter-http-converter](https://github.com/hengboy/api-boot/tree/master/api-boot-samples/api-boot-sample-http-converter) | 集成FastJson作为格式化返回JSON |
9-
| [api-boot-starter-security-oauth-jwt](https://github.com/hengboy/api-boot/tree/master/api-boot-samples/api-boot-sample-security-oauth-jwt) | 集成SpringSecurity、Oauth、Jwt安全、认证框架 |
10-
| [api-boot-starter-swagger](https://github.com/hengboy/api-boot/tree/master/api-boot-samples/api-boot-sample-swagger) | 集成Swagger2作为接口服务文档 |
11-
| [api-boot-starter-alibaba-oss](https://github.com/hengboy/api-boot/tree/master/api-boot-samples/api-boot-sample-alibaba-oss) | 集成阿里云Oss对象存储接口服务 |
12-
| [api-boot-starter-alibaba-sms](https://github.com/hengboy/api-boot/tree/master/api-boot-samples/api-boot-sample-alibaba-sms) | 集成阿里云国际短信接口服务 |
8+
| [api-boot-starter-http-converter](https://github.com/hengboy/api-boot/tree/1.x/api-boot-samples/api-boot-sample-http-converter) | 集成FastJson作为格式化返回JSON |
9+
| [api-boot-starter-security-oauth-jwt](https://github.com/hengboy/api-boot/tree/1.x/api-boot-samples/api-boot-sample-security-oauth-jwt) | 集成SpringSecurity、Oauth、Jwt安全、认证框架 |
10+
| [api-boot-starter-swagger](https://github.com/hengboy/api-boot/tree/1.x/api-boot-samples/api-boot-sample-swagger) | 集成Swagger2作为接口服务文档 |
11+
| [api-boot-starter-alibaba-oss](https://github.com/hengboy/api-boot/tree/1.x/api-boot-samples/api-boot-sample-alibaba-oss) | 集成阿里云Oss对象存储接口服务 |
12+
| [api-boot-starter-alibaba-sms](https://github.com/hengboy/api-boot/tree/1.x/api-boot-samples/api-boot-sample-alibaba-sms) | 集成阿里云国际短信接口服务 |
1313

1414

1515

‎api-boot-samples/README.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
Demo列表：
44

5-
- [ApiBoot Security Oauth](https://github.com/hengboy/api-boot/tree/master/api-boot-samples/api-boot-sample-security-oauth-jwt)
6-
- [ApiBoot Swagger](https://github.com/hengboy/api-boot/tree/master/api-boot-samples/api-boot-sample-swagger)
7-
- [ApiBoot Http Converter](https://github.com/hengboy/api-boot/tree/master/api-boot-samples/api-boot-sample-http-converter)
8-
- [ApiBoot Alibaba OSS](https://github.com/hengboy/api-boot/tree/master/api-boot-samples/api-boot-sample-alibaba-oss)
9-
- [ApiBoot Alibaba SMS](https://github.com/hengboy/api-boot/tree/master/api-boot-samples/api-boot-sample-alibaba-sms)
5+
- [ApiBoot Security Oauth](https://github.com/hengboy/api-boot/tree/1.x/api-boot-samples/api-boot-sample-security-oauth-jwt)
6+
- [ApiBoot Swagger](https://github.com/hengboy/api-boot/tree/1.x/api-boot-samples/api-boot-sample-swagger)
7+
- [ApiBoot Http Converter](https://github.com/hengboy/api-boot/tree/1.x/api-boot-samples/api-boot-sample-http-converter)
8+
- [ApiBoot Alibaba OSS](https://github.com/hengboy/api-boot/tree/1.x/api-boot-samples/api-boot-sample-alibaba-oss)
9+
- [ApiBoot Alibaba SMS](https://github.com/hengboy/api-boot/tree/1.x/api-boot-samples/api-boot-sample-alibaba-sms)
1010

‎api-boot-samples/api-boot-sample-alibaba-oss/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
</dependency>
1515
```
1616

17-
`ApiBoot`所提供的依赖都不需要添加版本号，具体查看[ApiBoot版本依赖](https://github.com/hengboy/api-boot/blob/master/README.md#%E6%B7%BB%E5%8A%A0%E7%89%88%E6%9C%AC%E4%BE%9D%E8%B5%96)
17+
`ApiBoot`所提供的依赖都不需要添加版本号，具体查看[ApiBoot版本依赖](https://github.com/hengboy/api-boot/blob/1.x/README.md#%E6%B7%BB%E5%8A%A0%E7%89%88%E6%9C%AC%E4%BE%9D%E8%B5%96)
1818

1919
### 配置参数列表
2020

‎api-boot-samples/api-boot-sample-alibaba-sms/README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
</dependency>
1717
```
1818

19-
`ApiBoot`所提供的依赖都不需要添加版本号，具体查看[ApiBoot版本依赖](https://github.com/hengboy/api-boot/blob/master/README.md#%E6%B7%BB%E5%8A%A0%E7%89%88%E6%9C%AC%E4%BE%9D%E8%B5%96)
19+
`ApiBoot`所提供的依赖都不需要添加版本号，具体查看[ApiBoot版本依赖](https://github.com/hengboy/api-boot/blob/1.x/README.md#%E6%B7%BB%E5%8A%A0%E7%89%88%E6%9C%AC%E4%BE%9D%E8%B5%96)
2020

2121
### 配置参数列表
2222

@@ -74,4 +74,4 @@ param.put("code", "192369").put("name", "测试名称");
7474

7575
#### 发送结果反馈
7676

77-
执行短信发送后会返回`ApiBootSmsResponse`实例，通过该实例即可判断短信是否发送成功。
77+
执行短信发送后会返回`ApiBootSmsResponse`实例，通过该实例即可判断短信是否发送成功。

‎api-boot-samples/api-boot-sample-http-converter/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
</dependency>
1717
```
1818

19-
`ApiBoot`所提供的依赖都不需要添加版本号，具体查看[ApiBoot版本依赖](https://github.com/hengboy/api-boot/blob/master/README.md#%E6%B7%BB%E5%8A%A0%E7%89%88%E6%9C%AC%E4%BE%9D%E8%B5%96)
19+
`ApiBoot`所提供的依赖都不需要添加版本号，具体查看[ApiBoot版本依赖](https://github.com/hengboy/api-boot/blob/1.x/README.md#%E6%B7%BB%E5%8A%A0%E7%89%88%E6%9C%AC%E4%BE%9D%E8%B5%96)
2020

2121
### 相关配置
2222

‎api-boot-samples/api-boot-sample-security-oauth-jwt/README.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
</dependency>
1313
```
1414

15-
> `ApiBoot`所提供的依赖都不需要添加版本号，但是需要添加版本依赖，具体查看[ApiBoot版本依赖](https://github.com/hengboy/api-boot/blob/master/README.md#%E6%B7%BB%E5%8A%A0%E7%89%88%E6%9C%AC%E4%BE%9D%E8%B5%96)
15+
> `ApiBoot`所提供的依赖都不需要添加版本号，但是需要添加版本依赖，具体查看[ApiBoot版本依赖](https://github.com/hengboy/api-boot/blob/1.x/README.md#%E6%B7%BB%E5%8A%A0%E7%89%88%E6%9C%AC%E4%BE%9D%E8%B5%96)
1616
1717
### 配置参数列表
1818

@@ -24,7 +24,7 @@
2424
| ------------------------------------------------- | ------------------------------------------------------------ | ------------------------------------------------------------ | ----------- |
2525
| `api.boot.security.away` | SpringSecurity读取用户的方式，默认为内存方式 | memory | all |
2626
| `api.boot.security.auth-prefix` | 拦截的接口路径前缀，如：/api/users就会被默认拦截 | /api/** | memory/jdbc |
27-
| `api.boot.security.users` | 配置用户列表，具体使用查看[内存方式介绍](https://github.com/hengboy/api-boot/tree/master/api-boot-samples/api-boot-sample-security-oauth-jwt#%E5%86%85%E5%AD%98%E6%96%B9%E5%BC%8F%E9%BB%98%E8%AE%A4%E6%96%B9%E5%BC%8F) | 无 | memory |
27+
| `api.boot.security.users` | 配置用户列表，具体使用查看[内存方式介绍](https://github.com/hengboy/api-boot/tree/1.x/api-boot-samples/api-boot-sample-security-oauth-jwt#%E5%86%85%E5%AD%98%E6%96%B9%E5%BC%8F%E9%BB%98%E8%AE%A4%E6%96%B9%E5%BC%8F) | 无 | memory |
2828
| `api.boot.security.ignoring-urls` | `Spring Security`所排除的路径，默认排除Swagger、Actuator相关路径前缀 | /v2/api-docs<br />/swagger-ui.html<br />/swagger-resources/configuration/security<br />/META-INF/resources/webjars/**<br />/swagger-resources<br />/swagger-resources/configuration/ui<br />/actuator/** | memory/jdbc |
2929
| `api.boot.security.enable-default-store-delegate` | 仅在Jdbc方式生效 | true | jdbc |
3030

@@ -208,7 +208,7 @@ public class DisableDefaultUserTableStoreDelegate implements ApiBootStoreDelegat
208208

209209
**创建Oauth所需表结构**
210210

211-
`Oauth2`如果使用`Jdbc`方式进行存储`access_token`、`client_details`时，需要在数据库内初始化`Oauth2`所需相关表结构，[oauth-mysql.sql](https://github.com/hengboy/api-boot/tree/master/api-boot-project/api-boot-starters/api-boot-starter-security-oauth-jwt/oauth-mysql.sql)
211+
`Oauth2`如果使用`Jdbc`方式进行存储`access_token`、`client_details`时，需要在数据库内初始化`Oauth2`所需相关表结构，[oauth-mysql.sql](https://github.com/hengboy/api-boot/tree/1.x/api-boot-project/api-boot-starters/api-boot-starter-security-oauth-jwt/oauth-mysql.sql)
212212

213213
**添加客户端数据**
214214

@@ -251,4 +251,4 @@ api:
251251
sign-key: 恒宇少年 - 于起宇
252252
```
253253
254-
默认不启用`JWT`，`sign-key`签名建议进行更换。
254+
默认不启用`JWT`，`sign-key`签名建议进行更换。

‎api-boot-samples/api-boot-sample-swagger/README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
</dependency>
1515
```
1616

17-
> 注意：`ApiBoot`所提供的依赖都不需要添加版本号，但是需要添加版本依赖，具体查看[ApiBoot版本依赖](https://github.com/hengboy/api-boot/blob/master/README.md#%E6%B7%BB%E5%8A%A0%E7%89%88%E6%9C%AC%E4%BE%9D%E8%B5%96)
17+
> 注意：`ApiBoot`所提供的依赖都不需要添加版本号，但是需要添加版本依赖，具体查看[ApiBoot版本依赖](https://github.com/hengboy/api-boot/blob/1.x/README.md#%E6%B7%BB%E5%8A%A0%E7%89%88%E6%9C%AC%E4%BE%9D%E8%B5%96)
1818
1919
### @EnableApiBootSwagger
2020

@@ -43,7 +43,7 @@
4343

4444
如果你的项目添加了`Oauth2`资源保护，在`Swagger`界面上访问接口时需要设置`AccessToken`到`Header`才可以完成接口的访问，`ApiBoot Security Oauth`默认开放`Swagger`所有相关路径，如果项目内并非通过`ApiBoot Security Oauth2`来做安全认证以及资源保护，需要自行开放`Swagger`相关路径。
4545

46-
整合`ApiBoot Security Oauth`很简单，访问[ApiBoot Security Oauth](https://github.com/hengboy/api-boot/blob/master/api-boot-samples/api-boot-sample-security-oauth-jwt/README.md) 查看。
46+
整合`ApiBoot Security Oauth`很简单，访问[ApiBoot Security Oauth](https://github.com/hengboy/api-boot/blob/1.x/api-boot-samples/api-boot-sample-security-oauth-jwt/README.md) 查看。
4747

4848
### 携带Token访问Api
4949

0 commit comments

Comments
 (0)