现代化高性能云原生 API 网关

FLUX Gateway 是一款基于 Go 语言开发的现代化 API 网关，依托 Go 语言的高性能与简洁特性，集成了路由分发、负载均衡、流量限流、服务熔断及认证授权等核心能力。提供全链路 API 管理可视化功能，助力用户高效管控接口生命周期，为分布式系统构建稳定、安全、可观测的 API 接入层。默认 SQLite 即可启动，生产环境可切换 MySQL / Oracle / ClickHouse。

English | 简体中文  ·  Chat

---

目录： 架构 · 功能 · 界面 · 快速开始 · 升级 · 文档 · 贡献 · 联系

---

架构概览

_{图 1　请求处理链路：接入、安全、路由、负载、熔断、转发}

_{图 2　模块模型：网关、控制台、隧道与存储}

分层架构与隧道原理见 项目介绍 · 系统架构。

---

功能

能力	说明
流量治理	路由分发、多种负载均衡、限流、熔断
安全	JWT / OAuth2 / API Key，IP、域名与 User-Agent 访问控制
可观测	管理控制台、访问日志、运行指标
扩展与交付	插件；静态资源托管；二进制、Docker、Kubernetes

完整能力说明见 项目介绍。

---

界面

_{图 3　路由配置}

_{图 4　网关日志}

---

快速开始

示例版本 3.5.4，安装包与镜像以 GitHub Releases 最新版为准。

项	值
控制台	http://localhost:12003/gatewayweb
默认账号	admin / 123456（登录后立即修改）
网关端口	8080
进程健康检查	http://localhost:12003/health
监听口健康检查	http://localhost:8080/_gw/health（实例听上才有）

Docker

镜像内含配置、数据库脚本和前端资源，默认 SQLite。

docker pull ghcr.io/fluxsce/gateway:3.5.4

docker run -d --name gateway \
  -p 8080:8080 \
  -p 12003:12003 \
  ghcr.io/fluxsce/gateway:3.5.4

国内镜像：

docker pull crpi-25xt72cd1prwdj5s.cn-hangzhou.personal.cr.aliyuncs.com/datahub-images/gateway:3.5.4

个人版 ACR 通常需先 docker login。MySQL + Redis 编排见 容器化部署。

安装包

从 Releases 下载对应平台包。归档根目录为 gateway/。

文件	平台	数据库
gateway-linux-amd64-3.5.4.tar.gz	Linux amd64	MySQL / SQLite / ClickHouse
gateway-linux-arm64-3.5.4.tar.gz	Linux arm64	同上
gateway-windows-amd64-3.5.4.zip	Windows amd64	同上
gateway-linux-amd64-oracle-3.5.4.tar.gz	Linux amd64	上表 + Oracle
gateway-windows-amd64-oracle-3.5.4.zip	Windows amd64	上表 + Oracle

tar -xzf gateway-linux-amd64-3.5.4.tar.gz
cd gateway
./gateway --config ./configs

Windows：gateway.exe --config .\configs。默认 SQLite，库文件 scripts/data/gateway.db，启动时执行 scripts/db 下的初始化脚本。

系统服务与生产配置见 安装部署。

源码

需要 Go 1.24+。SQLite 使用 go-sqlite3，必须开启 CGO（Windows 先安装 TDM-GCC 并重开终端）。

git clone https://github.com/fluxsce/gateway.git
cd gateway
go env -w GOPROXY=https://goproxy.cn,direct   # 国内建议
go mod download
go run cmd/app/main.go --config ./configs

控制台静态资源来自 web/frontend/dist（不随仓库提交）：

cd web/frontend
pnpm install
pnpm run dev:vite

开发服务器将 API 代理到 http://127.0.0.1:12003。亦可 pnpm run build 后由网关托管 dist。完整步骤见 开发指南。

---

版本升级

以 /opt/gateway 为例。先备份 database.yaml，解压覆盖后再拷回。

sudo systemctl stop gateway
sudo cp /opt/gateway/configs/database.yaml /tmp/database.yaml.bak
sudo tar -xzf gateway-linux-amd64-*.tar.gz -C /opt
sudo cp /tmp/database.yaml.bak /opt/gateway/configs/database.yaml
sudo systemctl start gateway

Windows 与 Docker 见 安装部署、容器化部署。

---

文档

完整目录：中文 · English

文档	说明
项目介绍	能力、架构与适用场景
第一条路由	控制台：实例、服务、路由、重载
静态资源托管	用网关发布本地静态站点
FAQ	启动、端口、账号与常见错误
安装部署	安装包、系统服务、升级
容器化部署	Docker / Kubernetes
发版流水线	产物与镜像 tag
开发指南	源码编译与本地联调
数据库规范	表结构与命名
调试指南	排查与性能
错误处理	错误处理约定
SECURITY.md	安全与漏洞报告

---

参与贡献

请阅读 社区行为准则 与 贡献指南。中文摘要：CONTRIBUTING_CN.md。

开源协议

Apache License 2.0

Star 历史

---

联系

感谢 所有贡献者。

• 邮箱：fluxopensource@flux.com.cn
• Issues：提交问题
• Discussions：讨论区
• 微信群：扫描下方二维码加入交流群

企业微信

微信

_{Built by the Gateway team}