update name
Update README.md Update README.md Update README.en-us.md Update README.md Update README.md Update README.md
This commit is contained in:
linwaiwai
173
README.md
173
README.md
@@ -1,41 +1,48 @@
|
||||
[English](./README.en-us.md) | 简体中文
|
||||
<p align="center" >
|
||||
<a href="https://www.fizzgate.com"><img src="https://raw.githubusercontent.com/wiki/fizzgate/fizz-gateway-community/img/icon-color.png" width="70%"></a>
|
||||
<a href="https://www.fizzgate.com"><img src="https://www.fizzgate.com/fizz/nav-bar/logo.png?v=1" width="70%"></a>
|
||||
</p>
|
||||
<p>
|
||||
<img alt="Version" src="https://img.shields.io/badge/version-2.7.2-blue.svg?cacheSeconds=2592000" />
|
||||
<a href="http://www.fizzgate.com/fizz-gateway-community/" target="_blank">
|
||||
<img alt="Version" src="https://img.shields.io/badge/version-2.7.1-blue.svg?cacheSeconds=2592000" />
|
||||
<a href="http://www.fizzgate.com/fizz-gateway-node/" target="_blank">
|
||||
<img alt="Documentation" src="https://img.shields.io/badge/documentation-yes-brightgreen.svg" />
|
||||
</a>
|
||||
<a href="#" target="_blank">
|
||||
<img alt="License: GPL--3.0" src="https://img.shields.io/badge/License-GPL--3.0-yellow.svg" />
|
||||
<img alt="License: AGPL--3.0" src="https://img.shields.io/badge/License-AGPL--3.0-yellow.svg" />
|
||||
</a>
|
||||
<a href="https://github.com/fizzgate/fizz-gateway-community/actions" target="_blank">
|
||||
<img alt="Java CI with Maven" src="https://github.com/fizzgate/fizz-gateway-community/workflows/Java%20CI%20with%20Maven/badge.svg?branch=master" />
|
||||
<a href="https://github.com/fizzgate/fizz-gateway-node/actions" target="_blank">
|
||||
<img alt="Java CI with Maven" src="https://github.com/fizzgate/fizz-gateway-node/workflows/Java%20CI%20with%20Maven/badge.svg?branch=master" />
|
||||
</a>
|
||||
</p>
|
||||
|
||||
- **最新QQ交流群**: 512164278
|
||||
|
||||
## Fizz Gateway是什么？
|
||||
## FizzGate是什么？
|
||||
|
||||
An Aggregation API Gateway in Java . Fizz Gateway 是一个基于 Java开发的微服务聚合网关，是拥有自主知识产权的应用网关国产化替代方案，能够实现热服务编排聚合、自动授权选择、线上服务脚本编码、在线测试、高性能路由、API审核管理、回调管理等目的，拥有强大的自定义插件系统可以自行扩展，并且提供友好的图形化配置界面，能够快速帮助企业进行API服务治理、减少中间层胶水代码以及降低编码投入、提高 API 服务的稳定性和安全性。
|
||||
An Aggregation API Gateway in Java . FizzGate 是一个基于 Java开发的微服务聚合网关，是拥有自主知识产权的应用网关国产化替代方案，能够实现热服务编排聚合、自动授权选择、线上服务脚本编码、在线测试、高性能路由、API审核管理、回调管理等目的，拥有强大的自定义插件系统可以自行扩展，并且提供友好的图形化配置界面，能够快速帮助企业进行API服务治理、减少中间层胶水代码以及降低编码投入、提高 API 服务的稳定性和安全性。
|
||||
## 官方网站
|
||||
|
||||
https://www.fizzgate.com/
|
||||
|
||||
备用地址：https://www.fizzcrm.com/
|
||||
|
||||
## 演示环境（Demo）
|
||||
|
||||
http://demo.fizzgate.com/
|
||||
https://demo.fizzgate.com/
|
||||
|
||||
备用站点：https://demo.fizzcrm.com/
|
||||
|
||||
账号/密码:`admin`/`Aa123!`
|
||||
|
||||
健康检查地址：http://demo.fizzgate.com/admin/health (线上版本请限制admin路径的外网访问)
|
||||
健康检查地址：https://demo.fizzgate.com/admin/health (线上版本请限制admin路径的外网访问)
|
||||
|
||||
API地址：http://demo.fizzgate.com/proxy/[服务名]/[API_Path]
|
||||
API地址：https://demo.fizzgate.com/proxy/[服务名]/[API_Path]
|
||||
|
||||
## Fizz的设计
|
||||
## FizzGate的设计
|
||||
|
||||
<img width="500" src="https://user-images.githubusercontent.com/184315/97130741-33a90d80-177d-11eb-8680-f589a36e44b3.png" />
|
||||
|
||||
## Fizz典型应用场景
|
||||
## FizzGate典型应用场景
|
||||
|
||||
<img width="90%" src="https://user-images.githubusercontent.com/6129661/216249866-71eb54de-d2e8-44ce-8e70-a1ca1f51553d.png" />
|
||||
|
||||
@@ -44,7 +51,7 @@ API地址：http://demo.fizzgate.com/proxy/[服务名]/[API_Path]
|
||||
- API管理：支持API定义后端服务的配置；
|
||||
- 分组管理：支持通过分组管理实现同一分组的API使用相关的配置；
|
||||
- 服务鉴权：通过插件可对服务进行应用访问权限、检验等链式的拦截策略；
|
||||
- 集群管理：Fizz网关节点是无状态的，配置信息自动同步，支持节点水平拓展和多集群部署。
|
||||
- 集群管理：FizzGate网关节点是无状态的，配置信息自动同步，支持节点水平拓展和多集群部署。
|
||||
- 安全授权：支持内置的key-auth, JWT, basic-auth授权方式，并且可以方便控制。
|
||||
- 服务编排：支持HTTP、Dubbo、gRPC、Soap协议热服务编排能力，支持前后端编码，支持JSON/XML输出，随时随地更新API。
|
||||
- 负载均衡：支持round-robin负载均衡。
|
||||
@@ -67,7 +74,7 @@ API地址：http://demo.fizzgate.com/proxy/[服务名]/[API_Path]
|
||||
|
||||
## 基准测试
|
||||
|
||||
我们将Fizz与市面上主要的网关产品进行比较，使用相同的环境和条件，测试对象均为单个节点。Mock接口模拟20ms时延，报文大小约2K。
|
||||
我们将FizzGate与市面上主要的网关产品进行比较，使用相同的环境和条件，测试对象均为单个节点。Mock接口模拟20ms时延，报文大小约2K。
|
||||
|
||||
- Intel(R) Xeon(R) CPU E5-2650 v3 @ 2.30GHz * 4
|
||||
- Linux version 3.10.0-957.21.3.el7.x86_64
|
||||
@@ -77,19 +84,19 @@ API地址：http://demo.fizzgate.com/proxy/[服务名]/[API_Path]
|
||||
| :------------------ | :------------------ | :-------: | :-------: | :-------: | :-------: |
|
||||
| 后端服务 | 直接访问后端服务 | 23540| 32.19 | 27325| 52.09 |
|
||||
| 流量网关 | kong <br/>v2.4.1 | 15662 | 50.87 | 17152 | 84.3 |
|
||||
| 应用网关 | fizz-gateway-community <br/>v2.0.0 | 12206 | 65.76 | 12766 | 100.34 |
|
||||
| 应用网关 | fizz-gateway-node <br/>v2.0.0 | 12206 | 65.76 | 12766 | 100.34 |
|
||||
| 应用网关 | spring-cloud-gateway <br/>v2.2.9| 11323 | 68.57 | 10472 | 127.59 |
|
||||
| 应用网关 | shenyu <br/>v2.3.0| 9284 | 92.98 | 9939 | 148.61 |
|
||||
|
||||
## 版本对照
|
||||
|
||||
- Fizz-gateway-community： 社区版
|
||||
- fizz-gateway-node： 节点端
|
||||
|
||||
- Fizz-manager-professional：管理后台专业版（服务端）
|
||||
- fizz-manager-professional：管理后台专业版（服务端）
|
||||
|
||||
- Fizz-admin-professional：管理后台专业版（前端）
|
||||
- fizz-admin-professional：管理后台专业版（前端）
|
||||
|
||||
| Fizz-gateway-community | Fizz-manager-professional | Fizz-admin-professional |
|
||||
| fizz-gateway-node | fizz-manager-professional | fizz-admin-professional |
|
||||
| ---------------------- | ------------------------- | ----------------------- |
|
||||
| v1.0.0 | v1.0.0 | v1.0.0 |
|
||||
| v1.1.0 | v1.1.0 | v1.1.0 |
|
||||
@@ -98,21 +105,43 @@ API地址：http://demo.fizzgate.com/proxy/[服务名]/[API_Path]
|
||||
|
||||
从v1.3.0开始管理后台的前端和服务端合并成一个包
|
||||
|
||||
- Fizz-gateway-community： 社区版
|
||||
- fizz-gateway-node： 节点端
|
||||
|
||||
- Fizz-manager-professional：管理后台
|
||||
- fizz-manager-professional：管理后台
|
||||
|
||||
| Fizz-gateway-community | Fizz-manager-professional |
|
||||
| fizz-gateway-node | fizz-manager-professional |
|
||||
|------------------------|---------------------------|
|
||||
| v1.3.0 | v1.3.0 |
|
||||
| ... | ... |
|
||||
| v1.4.0 | v1.4.0 |
|
||||
| v1.4.1 | v1.4.1 |
|
||||
| v1.5.0 | v1.5.0 |
|
||||
| v1.5.1 | v1.5.1 |
|
||||
| v2.0.0 | v2.0.0 |
|
||||
| v2.1.0 | v2.1.0 |
|
||||
| v2.2.0 | v2.2.0 |
|
||||
| v2.2.1 | v2.2.1 |
|
||||
| v2.2.3 | v2.2.3 |
|
||||
| v2.3.0 | v2.3.0 |
|
||||
| v2.3.2 | v2.3.2 |
|
||||
| v2.3.3 | v2.3.3 |
|
||||
| v2.4.0 | v2.4.0 |
|
||||
| v2.4.1 | v2.4.1 |
|
||||
| v2.5.0 | v2.5.0 |
|
||||
| v2.5.1 | v2.5.1 |
|
||||
| v2.5.2 | v2.5.2 |
|
||||
| v2.6.0 | v2.6.0 |
|
||||
| v2.6.1 | v2.6.1 |
|
||||
| v2.6.2 | v2.6.2 |
|
||||
| v2.6.3 | v2.6.3 |
|
||||
| v2.6.4 | v2.6.4 |
|
||||
| v2.6.5 | v2.6.5 |
|
||||
| v2.6.6 | v2.6.6 |
|
||||
| v2.7.0 | v2.7.0 |
|
||||
| v2.7.1 | v2.7.1 |
|
||||
| v2.7.2 | v2.7.2 |
|
||||
|
||||
|
||||
请根据社区版的版本下载对应的管理后台版本
|
||||
请根据节点端的版本下载对应的管理后台版本
|
||||
|
||||
## 部署说明
|
||||
|
||||
@@ -129,7 +158,7 @@ API地址：http://demo.fizzgate.com/proxy/[服务名]/[API_Path]
|
||||
|
||||
依赖的安装可参考详细部署教程
|
||||
|
||||
### 安装Fizz
|
||||
### 安装FizzGate
|
||||
|
||||
#### 一、安装管理后台
|
||||
|
||||
@@ -151,7 +180,7 @@ API地址：http://demo.fizzgate.com/proxy/[服务名]/[API_Path]
|
||||
|
||||
安装方式二（v2.0.0或以上版本）：docker:
|
||||
|
||||
SQL脚本下载页：https://github.com/fizzgate/fizz-gateway-community/releases/tag/{version} （把{version}替换为对应版本号）
|
||||
SQL脚本下载页：https://github.com/fizzgate/fizz-gateway-node/releases/tag/{version} （把{version}替换为对应版本号）
|
||||
|
||||
首次安装执行`fizz-manager-professional-{version}-mysql.sql`数据库脚本，从低版本升级至高版本选择执行update目录下对应升级脚本（如有脚本则执行）
|
||||
|
||||
@@ -180,7 +209,7 @@ docker run --rm -d -p 8000:8000 \
|
||||
|
||||
服务启动后访问 http://{部署机器IP地址}:8000/#/login，使用超级管理员账户`admin`密码`Aa123!`登录
|
||||
|
||||
#### 二、安装fizz-gateway-community社区版
|
||||
#### 二、安装fizz-gateway-node节点端
|
||||
|
||||
说明：
|
||||
|
||||
@@ -190,7 +219,7 @@ docker run --rm -d -p 8000:8000 \
|
||||
|
||||
安装方式一：二进制安装包
|
||||
|
||||
1. 下载fizz-gateway-community的二进制安装包，解压修改application.yml配置文件里配置中心、注册中心、redis(redis配置需与管理后台一致)的配置
|
||||
1. 下载fizz-gateway-node的二进制安装包，解压修改application.yml配置文件里配置中心、注册中心、redis(redis配置需与管理后台一致)的配置
|
||||
2. 根据需要修改boot.sh脚本的apollo连接，不使用apollo配置中心可跳过
|
||||
3. Linux启动 执行 `./boot.sh start` 命令启动服务，支持 start/stop/restart/status命令
|
||||
4. Windows启动 执行`.\boot.cmd start` 命令启动服务，支持 start/stop/restart/status命令
|
||||
@@ -198,12 +227,12 @@ docker run --rm -d -p 8000:8000 \
|
||||
安装方式二：源码安装:
|
||||
|
||||
1. 本地clone仓库上的最新代码，修改application.yml配置文件里配置中心、注册中心、redis(redis配置需与管理后台一致)的配置
|
||||
2. 在项目根目录fizz-gateway-community下执行Maven命令`mvn clean package install -DskipTests=true`
|
||||
3. 在项目目录fizz-gateway-community/fizz-bootstrap下执行Maven命令`mvn clean package -DskipTests=true`
|
||||
4. 进入fizz-gateway-community/fizz-bootstrap/target/fizz-gateway-community目录，执行 `./boot.sh start` 命令启动服务，支持 start/stop/restart/status命令
|
||||
2. 在项目根目录fizz-gateway-node下执行Maven命令`mvn clean package install -DskipTests=true`
|
||||
3. 在项目目录fizz-gateway-node/fizz-bootstrap下执行Maven命令`mvn clean package -DskipTests=true`
|
||||
4. 进入fizz-gateway-node/fizz-bootstrap/target/fizz-gateway-node目录，执行 `./boot.sh start` 命令启动服务，支持 start/stop/restart/status命令
|
||||
|
||||
安装方式三（v2.0.0或以上版本）：docker:
|
||||
1. 下载对应版本的镜像：docker pull fizzgate/fizz-gateway-community:{version}
|
||||
1. 下载对应版本的镜像：docker pull fizzgate/fizz-gateway-node:{version}
|
||||
2. 通过环境变量方式修改redis配置（其它配置同理）并运行镜像
|
||||
```sh
|
||||
docker run --rm -d -p 8600:8600 \
|
||||
@@ -211,94 +240,94 @@ docker run --rm -d -p 8600:8600 \
|
||||
-e "aggregate.redis.port={your redis port}" \
|
||||
-e "aggregate.redis.password={your redis password}" \
|
||||
-e "aggregate.redis.database={your redis database}" \
|
||||
fizzgate/fizz-gateway-community:{version}
|
||||
fizzgate/fizz-gateway-node:{version}
|
||||
```
|
||||
|
||||
或通过映射目录方式使用外部配置文件和输出日志到宿主机, 配置文件可从安装包或源码里获取，在宿主机创建fizz-gateway-community/config和fizz-gateway-community/logs目录，把application.yml和log4j2-spring.xml配置文件放置config下，在fizz-gateway-community目录下运行镜像
|
||||
或通过映射目录方式使用外部配置文件和输出日志到宿主机, 配置文件可从安装包或源码里获取，在宿主机创建fizz-gateway-node/config和fizz-gateway-node/logs目录，把application.yml和log4j2-spring.xml配置文件放置config下，在fizz-gateway-node目录下运行镜像
|
||||
|
||||
```sh
|
||||
cd fizz-gateway-community
|
||||
cd fizz-gateway-node
|
||||
docker run --rm -d -p 8600:8600 \
|
||||
-v $PWD/config:/opt/fizz-gateway-community/config \
|
||||
-v $PWD/logs:/opt/fizz-gateway-community/logs fizzgate/fizz-gateway-community:{version}
|
||||
-v $PWD/config:/opt/fizz-gateway-node/config \
|
||||
-v $PWD/logs:/opt/fizz-gateway-node/logs fizzgate/fizz-gateway-node:{version}
|
||||
```
|
||||
|
||||
最后访问网关，地址形式为：http://127.0.0.1:8600/[服务名]/[API_Path]
|
||||
|
||||
## 官方技术交流群
|
||||
|
||||
Fizz官方技术交流④群：170145598 (推荐)
|
||||
FizzGate官方技术交流④群：170145598 (推荐)
|
||||
|
||||
Fizz官方技术交流①群（已满）
|
||||
FizzGate官方技术交流①群（已满）
|
||||
|
||||
Fizz官方技术交流②群（已满）
|
||||
FizzGate官方技术交流②群（已满）
|
||||
|
||||
Fizz官方技术交流③群：512164278
|
||||
FizzGate官方技术交流③群：512164278
|
||||
|
||||
Fizz官方微信群（请加入群之后再询问群主）
|
||||
FizzGate官方微信群（请加入群之后再询问群主）
|
||||
|
||||
|
||||
## 相关文章
|
||||
|
||||
[服务器减少50%，研发效率提高86%，我们的管理型网关Fizz自研之路](https://www.infoq.cn/article/9wdfiOILJ0CYsVyBQFpl)
|
||||
[服务器减少50%，研发效率提高86%，我们的管理型网关FizzGate自研之路](https://www.infoq.cn/article/9wdfiOILJ0CYsVyBQFpl)
|
||||
|
||||
[简单易用的微服务聚合网关首选：Fizz Gateway安装教程](https://my.oschina.net/linwaiwai/blog/4696224)
|
||||
[简单易用的微服务聚合网关首选：FizzGate安装教程](https://my.oschina.net/linwaiwai/blog/4696224)
|
||||
|
||||
[大厂推荐使用的网关解密：Fizz Gateway管理后台使用教程](https://my.oschina.net/linwaiwai/blog/4696124)
|
||||
[大厂推荐使用的网关解密：FizzGate管理后台使用教程](https://my.oschina.net/linwaiwai/blog/4696124)
|
||||
|
||||
[架构师效率快的终极原因：Fizz Gateway网关之服务编排](https://my.oschina.net/linwaiwai/blog/4696116)
|
||||
[架构师效率快的终极原因：FizzGate网关之服务编排](https://my.oschina.net/linwaiwai/blog/4696116)
|
||||
|
||||
[高阶架构师支招：Fizz Gateway的插件开发](https://my.oschina.net/linwaiwai/blog/4696131)
|
||||
[高阶架构师支招：FizzGate的插件开发](https://my.oschina.net/linwaiwai/blog/4696131)
|
||||
|
||||
[高阶程序员必备技能：Fizz Gateway网关的二次开发](https://my.oschina.net/linwaiwai/blog/4696133)
|
||||
[高阶程序员必备技能：FizzGate网关的二次开发](https://my.oschina.net/linwaiwai/blog/4696133)
|
||||
|
||||
[Fizz网关入门教程-安装](https://zhuanlan.zhihu.com/p/501305059)
|
||||
[FizzGate网关入门教程-安装](https://zhuanlan.zhihu.com/p/501305059)
|
||||
|
||||
[Fizz网关入门教程-路由初体验](https://zhuanlan.zhihu.com/p/501381970)
|
||||
[FizzGate网关入门教程-路由初体验](https://zhuanlan.zhihu.com/p/501381970)
|
||||
|
||||
[Fizz网关入门教程-权限校验](https://zhuanlan.zhihu.com/p/501384396)
|
||||
[FizzGate网关入门教程-权限校验](https://zhuanlan.zhihu.com/p/501384396)
|
||||
|
||||
[Fizz网关入门教程-快速聚合多接口，提高页面数据的加载速度](https://zhuanlan.zhihu.com/p/501387154)
|
||||
[FizzGate网关入门教程-快速聚合多接口，提高页面数据的加载速度](https://zhuanlan.zhihu.com/p/501387154)
|
||||
|
||||
[Fizz网关入门教程-服务编排，祭出终结BFF层的大杀器](https://zhuanlan.zhihu.com/p/501389075)
|
||||
[FizzGate网关入门教程-服务编排，祭出终结BFF层的大杀器](https://zhuanlan.zhihu.com/p/501389075)
|
||||
|
||||
[企业级微服务API网关Fizz-常用插件介绍](https://zhuanlan.zhihu.com/p/513656382)
|
||||
[企业级微服务API网关FizzGate-常用插件介绍](https://zhuanlan.zhihu.com/p/513656382)
|
||||
|
||||
[企业级微服务API网关Fizz-如何自定义插件](https://zhuanlan.zhihu.com/p/513662893)
|
||||
[企业级微服务API网关FizzGate-如何自定义插件](https://zhuanlan.zhihu.com/p/513662893)
|
||||
|
||||
[企业级微服务API网关Fizz-服务编排内置函数](https://zhuanlan.zhihu.com/p/513404417)
|
||||
[企业级微服务API网关FizzGate-服务编排内置函数](https://zhuanlan.zhihu.com/p/513404417)
|
||||
|
||||
[Fizz企业级微服务API网关进阶系列教程-服务编排处理列表数据(上)-展开与合并](https://zhuanlan.zhihu.com/p/515056309)
|
||||
[FizzGate企业级微服务API网关进阶系列教程-服务编排处理列表数据(上)-展开与合并](https://zhuanlan.zhihu.com/p/515056309)
|
||||
|
||||
[Fizz企业级微服务API网关进阶系列教程-服务编排处理列表数据(中)-数据提取与数据关联](https://zhuanlan.zhihu.com/p/515070075)
|
||||
[FizzGate企业级微服务API网关进阶系列教程-服务编排处理列表数据(中)-数据提取与数据关联](https://zhuanlan.zhihu.com/p/515070075)
|
||||
|
||||
[Fizz企业级微服务API网关进阶系列教程-服务编排处理列表数据(下)-字段重命名&字段移除](https://zhuanlan.zhihu.com/p/515509832)
|
||||
[FizzGate企业级微服务API网关进阶系列教程-服务编排处理列表数据(下)-字段重命名&字段移除](https://zhuanlan.zhihu.com/p/515509832)
|
||||
|
||||
|
||||
## 授权说明
|
||||
|
||||
1. 网关核心项目fizz-gateway-community社区版本以GNU v3的方式进行的开放，在遵循GNU协议的个人非商业化项目中可以免费使用。
|
||||
1. 网关核心项目fizz-gateway-node节点端本以GNU v3的方式进行的开放，任何商业使用都需要经过我们授权。
|
||||
|
||||
2. 管理后台项目(fizz-manager-professional)作为商业版本仅开放二进制包 [免费下载](https://wj.qq.com/s2/8682608/8fe2/)，而商业项目请注明公司名称联系我们（sale@fizzgate.com）进行授权，了解商业授权规则请点击[商业授权规则](https://github.com/fizzgate/fizz-gateway-community/wiki/%E5%95%86%E4%B8%9A%E6%8E%88%E6%9D%83)
|
||||
2. 管理后台项目(fizz-manager-professional)作为商业版本仅开放二进制包 [免费下载](https://wj.qq.com/s2/8682608/8fe2/)，而商业项目请注明公司名称联系我们（sale@fizzgate.com）进行授权，了解商业授权规则请点击[商业授权规则](https://github.com/fizzgate/fizz-gateway-node/wiki/%E5%95%86%E4%B8%9A%E6%8E%88%E6%9D%83)
|
||||
|
||||
3. 在选择Fizz Gateway之前，我们强烈建议您先试用一下我们的DEMO站点，试用我们的产品，并且思考与自身的业务结合，并且考虑产品推行落地方式，在查阅我们的官网价格(https://www.fizzgate.com) 之后再进一步与我们联系。
|
||||
3. 在选择FizzGate之前，我们强烈建议您先试用一下我们的DEMO站点，试用我们的产品，并且思考与自身的业务结合，并且考虑产品推行落地方式，在查阅我们的官网价格(https://www.fizzgate.com) 之后再进一步与我们联系。
|
||||
|
||||
## 系统截图
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user