Update README.md

This commit is contained in:
linwaiwai
2025-01-20 09:39:48 +08:00
committed by GitHub
parent d475673bb6
commit 2f6cba08ff

117
README.md
View File

@@ -28,14 +28,10 @@ An Aggregation API Gateway in Java . FizzGate 是一个基于 Java开发的微
https://www.fizzgate.com/ https://www.fizzgate.com/
备用地址https://www.fizzcrm.com/
## 演示环境Demo ## 演示环境Demo
https://demo.fizzgate.com/ https://demo.fizzgate.com/
备用站点https://demo.fizzcrm.com/
账号/密码: FizzGate是一款付费软件如有需求可直接购买或者添加企业微信免费试用 账号/密码: FizzGate是一款付费软件如有需求可直接购买或者添加企业微信免费试用
健康检查地址https://demo.fizzgate.com/admin/health (线上版本请限制admin路径的外网访问) 健康检查地址https://demo.fizzgate.com/admin/health (线上版本请限制admin路径的外网访问)
@@ -50,36 +46,59 @@ API地址https://demo.fizzgate.com/proxy/[服务名]/[API_Path]
<img width="90%" src="https://user-images.githubusercontent.com/6129661/216249866-71eb54de-d2e8-44ce-8e70-a1ca1f51553d.png" /> <img width="90%" src="https://user-images.githubusercontent.com/6129661/216249866-71eb54de-d2e8-44ce-8e70-a1ca1f51553d.png" />
## 设计理念
界面智能,依赖最小,功能全面,部署方便。力求简洁、清晰的界面设计,尽量将复杂的配置步骤和操作简化,以适应不同层级的用户需求,让开发人员、运维人员等都能够高效地进行管理和配置。
- 界面智能FizzGate 注重智能化设计,致力于提升用户体验。在用户输入时,系统将尽可能提供自动输入功能,减少用户操作的复杂度。同时,系统会在用户输入附近实时提供相关提示和提醒,帮助用户快速、准确地进行配置和操作。
- 依赖最小FizzGate 在设计时谨慎引入外部中间件和第三方依赖对现有系统完全无侵入。大多数功能基于自研技术实现最大程度地减少对外部依赖的需求减少部署资源消耗的同时保证系统的高效性和可维护性。这种设计使得FizzGate更加稳定并且能在企业内部网络中更加灵活地部署。
- 功能全面FizzGate 覆盖了整个 API 生命周期的管理,支持从 API 定义、集成、脱敏、溯源到安全防护等各个环节全面提升API管理的效率。作为市场上功能最全面的产品之一FizzGate 提供了一整套企业级解决方案帮助企业实现高效、安全的API管理。
- 部署方便FizzGate 在设计时充分考虑了企业级部署的需求,既支持小微企业的容灾需求,也能满足大型企业集群部署、异地多活部署的要求。部署过程简单快捷,最多一分钟即可解决企业的部署难题。
## 支持架构
支持arm64/amd64/x86/x86_64架构可以在Mac、Window、Linux使用支持信创使用麒麟V10达梦V8等主流信创组件。
## 产品特性 ## 产品特性
API管理
- 应用管理:支持对接入的应用进行管理; - 应用管理:支持对接入的应用进行管理;
- API管理支持API定义后端服务的配置 - API管理支持API定义后端服务的配置
- 分组管理支持通过分组管理实现同一分组的API使用相关的配置 - 分组管理支持通过分组管理实现同一分组的API使用相关的配置
- 服务鉴权:通过插件可对服务进行应用访问权限、检验等链式的拦截策略; - 服务鉴权:通过插件可对服务进行应用访问权限、检验等链式的拦截策略;
- 集群管理FizzGate网关节点是无状态的配置信息自动同步支持节点水平拓展和多集群部署 - 集群管理FizzGate网关节点是无状态的配置信息自动同步支持节点水平拓展和多集群部署
- 安全授权支持内置的key-auth, JWT, basic-auth授权方式并且可以方便控制 - 安全授权支持内置的key-auth, JWT, basic-auth授权方式并且可以方便控制
- 服务编排支持HTTP、Dubbo、gRPC、Soap协议热服务编排能力支持前后端编码支持JSON/XML输出随时随地更新API。 - 负载均衡支持round-robin负载均衡
- 负载均衡支持round-robin负载均衡。 - 策略熔断:根据服务或者具体地址进行多种恢复策略熔断配置;
- 策略熔断:根据服务或者具体地址进行多种恢复策略熔断配置。 - 多注册中心支持从Eureka或Nacos注册中心进行服务发现
- 多注册中心:支持从Eureka或Nacos注册中心进行服务发现。 - 配置中心:支持接入apollo配置中心
- 配置中心支持接入apollo配置中心。 - HTTP反向代理隐藏真实后端服务支持 Rest API反向代理
- HTTP反向代理隐藏真实后端服务支持 Rest API反向代理。 - 访问策略支持不同策略访问不同的API、配置不同的鉴权等
- 访问策略支持不同策略访问不同的API、配置不同的鉴权等。 - 黑白名单:支持配置通过绑定黑、白名单限制访问;
- 黑白名单:支持配置通过绑定黑、白名单限制访问。 - 自定义插件:强大的插件机制支持自由扩展;
- 自定义插件:强大的插件机制支持自由扩展。 - 可扩展:简单易用的插件机制方便扩展功能;
- 可扩展:简单易用的插件机制方便扩展功能。 - 高性能:性能在众多网关之中表现优异;
- 高性能:性能在众多网关之中表现优异。 - 管理后台:通过管理后台界面对网关集群进行各项配置;
- 版本控制:支持操作的发布和多次回滚。 - 重放管理:支持回调的管理、订阅、重放、以及日志;
- 管理后台:通过管理后台界面对网关集群进行各项配置。 - 多级限流细颗粒度的限流方式包含服务限流接口限流APP_ID限流IP限流
- 回调管理:支持回调的管理、订阅、重放、以及日志。 - 微服务文档:企业级管理开放微服务文档管理,系统集成更方便;
- 多级限流细颗粒度的限流方式包含服务限流接口限流APP_ID限流IP限流。 - 公网专线:建立公网中受到完全保护的私有连接通道;
- 微服务文档:企业级管理开放微服务文档管理,系统集成更方便。
- 公网专线:建立公网中受到完全保护的私有连接通道。
- 透明代理:支持透明代理方式串联 - 透明代理:支持透明代理方式串联
- API脱敏支持对API中涉密数据脱敏支持结构、非结构数据 API集成
- 脱敏策略:支持可视化的脱敏策略配置,根据上下文执行脱敏策略 - 服务编排支持HTTP、Dubbo、gRPC、Soap协议热服务编排能力支持前后端编码支持JSON/XML输出随时随地更新API
- 版本控制:支持操作的发布和多次回滚;
- 集成测试提供API集成测试功能确保API接口的可靠性和可用性
- 发布审核支持API编排发布的审核流程
API脱敏
- 分类分级:支持对不同敏感数据进行分类和分级管理,合理安排脱敏策略;
- API脱敏支持对API中涉密数据脱敏支持结构、非结构数据
- 脱敏策略:支持可视化的脱敏策略配置,根据上下文执行脱敏策略;
- 涉敏识别支持对API中的涉敏数据进行识别 - 涉敏识别支持对API中的涉敏数据进行识别
- 网页文件水印支持对代理的页面添加明水印。支持HTML、WORD/EXCEL/PPT/PDF、PNG/JPEG/JPEG2000/TIFF等类型 API溯源
- 泄露溯源支持根据泄露的数据信息追溯查询过相关数据的所有上下文及终端信息。支持JSON/HTML、WORD/EXCEL/PPT/PDF、PNG/JPEG/JPEG2000/TIFF等类型 - 网页文件水印:支持对代理的页面添加明水印。支持HTML、WORD/EXCEL/PPT/PDF、PNG/JPEG/TIFF等类型
- 泄露溯源支持根据泄露的数据信息追溯查询过相关数据的所有上下文及终端信息。支持JSON/HTML、WORD/EXCEL/PPT/PDF、PNG/JPEG/TIFF等类型
API安全旁路分析)
- 资产分析对API安全资产进行分析和管理生成API Spec帮助检测潜在的安全风险
- API漏洞支持对API接口的安全漏洞进行扫描、报告提升API的安全性
- API异常支持API异常访问检测功能及时发现异常行为并进行响应
- API阻断在发现异常时支持自动或手动阻断API的访问避免攻击扩散。
## 基准测试 ## 基准测试
@@ -93,7 +112,7 @@ API地址https://demo.fizzgate.com/proxy/[服务名]/[API_Path]
| :------------------ | :------------------ | :-------: | :-------: | :-------: | :-------: | | :------------------ | :------------------ | :-------: | :-------: | :-------: | :-------: |
| 后端服务 | 直接访问后端服务 | 23540| 32.19 | 27325| 52.09 | | 后端服务 | 直接访问后端服务 | 23540| 32.19 | 27325| 52.09 |
| 流量网关 | kong <br/>v2.4.1 | 15662 | 50.87 | 17152 | 84.3 | | 流量网关 | kong <br/>v2.4.1 | 15662 | 50.87 | 17152 | 84.3 |
| 应用网关 | fizz-gateway-node <br/>v2.0.0 | 12206 | 65.76 | 12766 | 100.34 | | 应用网关 | fizz-gateway-node <br/>v3.0.0 | 12206 | 65.76 | 12766 | 100.34 |
| 应用网关 | spring-cloud-gateway <br/>v2.2.9| 11323 | 68.57 | 10472 | 127.59 | | 应用网关 | spring-cloud-gateway <br/>v2.2.9| 11323 | 68.57 | 10472 | 127.59 |
| 应用网关 | shenyu <br/>v2.3.0| 9284 | 92.98 | 9939 | 148.61 | | 应用网关 | shenyu <br/>v2.3.0| 9284 | 92.98 | 9939 | 148.61 |
@@ -101,21 +120,6 @@ API地址https://demo.fizzgate.com/proxy/[服务名]/[API_Path]
- fizz-gateway-node 节点端 - fizz-gateway-node 节点端
- 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 |
| v1.1.1 | v1.1.1 | v1.1.1 |
| v1.2.0 | v1.2.0 | v1.2.0 |
从v1.3.0开始管理后台的前端和服务端合并成一个包
- fizz-gateway-node 节点端
- fizz-manager-professional管理后台 - fizz-manager-professional管理后台
| fizz-gateway-node | fizz-manager-professional | | fizz-gateway-node | fizz-manager-professional |
@@ -128,12 +132,31 @@ API地址https://demo.fizzgate.com/proxy/[服务名]/[API_Path]
| v3.2.0 | v3.2.0 | | v3.2.0 | v3.2.0 |
| v3.3.0 | v3.3.0 | | v3.3.0 | v3.3.0 |
| v3.5.0 | v3.5.0 | | v3.5.0 | v3.5.0 |
| v3.5.1 | v3.5.1 |
| v3.6.0 | v3.6.0 |
3.0.0之前的版本已停止维护,请根据节点端的版本下载对应的管理后台版本
## 一键安装
```bash
wget https://gitee.com/fizzgate/fizz-gateway-node/raw/master/install.sh && bash install.sh
```
说明一键安装包使用docker-compose进行安装yml文件已经内置镜像代理。如果您已经下载过docker-compose.yml文件请删除重新下载。在安装之前请增加代理镜像地址。
请根据节点端的版本下载对应的管理后台版本 ```bash
sudo tee /etc/docker/daemon.json <<EOF
{
"registry-mirrors": ["https://hub.fizzgateway.com"]
}
EOF
## 部署说明 sudo systemctl daemon-reload
sudo systemctl restart docker
```
## 手动安装
### 部署说明
[详细部署教程>>>](http://www.fizzgate.com/guide/installation/) [详细部署教程>>>](http://www.fizzgate.com/guide/installation/)
@@ -148,8 +171,6 @@ API地址https://demo.fizzgate.com/proxy/[服务名]/[API_Path]
依赖的安装可参考详细部署教程 依赖的安装可参考详细部署教程
### 安装FizzGate
#### 一、安装管理后台 #### 一、安装管理后台
[下载](https://www.fizzgate.com/fizz/cms/article/download/last/) fizz-manager-professional 安装包 [下载](https://www.fizzgate.com/fizz/cms/article/download/last/) fizz-manager-professional 安装包
@@ -284,7 +305,7 @@ docker run --rm -d -p 8600:8600 \
## 授权说明 ## 授权说明
1. 网关核心项目fizz-gateway-node节点端本以GNU v3的方式进行的开放任何商业使用都需要经过我们授权。 1. 网关核心项目fizz-gateway-node节点端本以GNU v3的方式进行的开放仅供技术朋友学习,任何商业使用都需要经过我们授权。
2. 管理后台项目(fizz-manager-professional)作为商业版本仅开放二进制包 [免费下载](https://www.fizzgate.com/fizz/cms/article/download/last/)而商业项目请注明公司名称联系我们sale@fizzgate.com进行授权了解商业授权规则请点击[商业授权规则](https://github.com/fizzgate/fizz-gateway-node/wiki/%E5%95%86%E4%B8%9A%E6%8E%88%E6%9D%83) 2. 管理后台项目(fizz-manager-professional)作为商业版本仅开放二进制包 [免费下载](https://www.fizzgate.com/fizz/cms/article/download/last/)而商业项目请注明公司名称联系我们sale@fizzgate.com进行授权了解商业授权规则请点击[商业授权规则](https://github.com/fizzgate/fizz-gateway-node/wiki/%E5%95%86%E4%B8%9A%E6%8E%88%E6%9D%83)