Skip to content

G
goku-api-gateway

Eolink / goku-api-gateway
上一次同步 1 年多

通知 133
Star 2991
Fork 611
G
goku-api-gateway

体验新版 GitCode，发现更多精彩内容 >>

未验证 提交 beee46c3 编写于 作者: E EOLINKER 提交者： GitHub
浏览文件
操作

Update README.md

上级 ccd3a43c
隐藏空白更改
内联 并排
Showing with 213 addition and 115 deletion
README.md
浏览文件 @ beee46c3
# GoKu API Gateway CE（悟空API网关 开源版）
![Goku API Gateway 悟空网关](https://data.eolinker.com/XvyujZze7c71e4d2ae5f2fd07206f1afaa02289bac346ef.jpg "Goku API Gateway 悟空网关")
Goku API Gateway （中文名：悟空 API 网关）是一个基于 Golang + MySQL + Redis 开发的微服务网关，能够实现高性能 HTTP API 转发、多租户管理、API 访问权限控制等目的，拥有强大的自定义插件系统可以自行扩展，并且提供友好的图形化配置界面，能够快速帮助企业进行 API 服务治理、提高 API 服务的稳定性和安全性。
# 概况
- [为什么要使用 Goku API Gateway？](#为什么要使用 Goku API Gateway？ "为什么要使用 Goku API Gateway？")
- [产品特性](#产品特性 "产品特性")
- [快速安装](#快速安装 "快速安装")
- [企业支持](#企业支持与帮助 "企业支持")
- [关于我们（Eolinker）](#关于我们（Eolinker） "关于我们（Eolinker）")
- [授权协议](#授权协议 "授权协议")
# 为什么要使用 Goku API Gateway？
Goku API Gateway （悟空 API 网关）是运行在企业系统服务边界上的微服务网关。当您构建网站、App、IOT甚至是开放API交易时，Goku API Gateway 能够帮你将内部系统中重复的组件抽取出来并放置在Goku网关上运行，如进行用户授权、访问控制、流量监控、防火墙、静态数据缓存、数据转换等。
Goku API Gateway 的社区版本（CE）拥有完善的使用指南和二次开发指南，代码使用纯 Go 语言编写，拥有良好的性能和扩展性，并且内置的插件系统能够让企业针对自身业务进行定制开发。
并且 Goku API Gateway 支持与 EOLINKER 旗下的 API Studio 接口管理平台结合，对 API 进行全面的管理、自动化测试、监控和运维。
总而言之，Goku API Gateway 能让业务开发团队更加专注地实现业务。
# 产品特性
- **集群管理**：多个 Goku API Gateway 节点，配置信息自动同步，支持多集群部署。
- **界面管理后台**：通过清晰的UI界面对网关的各项配置进行管理。
- **负载均衡**：对后端服务器进行负载均衡。
- **服务发现**：从 Consul、Eureka 等注册中心发现后端服务器。
- **转发代理**：通过转发请求来隐藏真实后端服务，支持 Rest API、Webservice。
- **多租户管理**：根据不同的访问终端或用户来判断。
- **访问鉴权**：Basic、API Key等。
- **API监控**：请求数据统计。
- **API告警**：支持通过API、邮件方式对异常的服务进行告警。
- **健康检查**：动态发现异常的网关节点以及后端节点，自动切断转发流量并转到其他正常后端服务。
- **异常自动重启**：网关节点异常时会自动尝试重载重启。
- **灵活的转发规则**：支持模糊匹配请求路径，支持改写转发路径等。
- **插件系统**：基于 Go 语言的插件系统，可以快速开发高性能的插件。
- **性能扩展**：网关节点拥有良好的处理性能，支持水平扩展节点数量满足不同的性能需求。
- **日志**：详细的系统日志、请求日志等。
- **Open API**：提供 API 对网关进行操作，便于集成。
- ...
# 快速安装
> 建议控制台与节点分别部署在不同的服务器上，一般一台服务器/虚拟机部署一个网关节点。
> 若要使用多个网关节点，需要将节点文件放置进多台服务器，并且在控制台新建多个节点。
> 此处为编译版本（release）的部署指南，点击查看：[源码版本（source_code）的部署指南](https://help.eolinker.com/#/tutorial/?groupID=c-346&productID=19 "点击源码版本（source_code）的部署指南")
### 环境准备
* **linux系统，内核版本 2.6.23+**
* **mysql ，版本 5.7+**
* **redis ，版本 2.8+，推荐3.0及以上版本**
* **net-tools**
### 安装文件描述
AGW的安装包包含两个文件 **goku-console（控制台安装包）** 和 **goku-node（网关节点安装包）**。
一、goku-console（控制台安装包）里文件目录如下
| 目录名称 | 含义 |
| ------------ | ------------ |
| goku-ce-console | 编译后的网关控制台文件 |
| goku-sql| mysql数据库安装脚本 |
其中goku-ce-console（控制台文件）里包含一个程序：
* gateway-console：控制台程序
二、goku-node（网关节点安装包）里文件目录如下
| 目录名称 | 含义 |
| ------------ | ------------ |
| goku-ce-node | 编译后的网关节点文件 |
其中goku-ce-node（节点文件）里包含一个程序：
* gateway-node：节点程序
### 安装数据库
1. 新建数据库goku_ce
2. 进入goku-console>>goku-sql文件夹，将goku_ce.sql导入到数据库
```
mysql -u <用户名> -p<密码> <./goku_ce.sql
```
### 安装控制台
#### 1. 编辑控制台配置文件
进入goku-ce-console/config文件夹：cd goku-ce-console/config ，编辑控制台的 **goku.conf** 文件，文件配置编辑语法参照yaml。
通过写控制台的goku.conf配置文件，控制台后端可以知道远程数据库相关信息及监听的端口号：
```
vi goku.conf
```
控制台的goku.conf文件配置字段如下：
```
admin_bind: 绑定节点获取配置的地址，形如IP:Port，填写内网地址或本机地址
listen_port: 管理后台监听端口，可以开放给外网访问
db_host: 数据库Host
db_port: 数据库监听端口
db_name: 数据库名称
db_user: 登录数据库的用户名
db_password: 登录数据库的密码
![](http://data.eolinker.com/course/Y9EYfxU069c9bc2f7a7f1e211966173e296cd04f768ee82)
```
## 简介
#### 2. 编辑网关集群的yaml配置文件
**GoKu API Gateway CE，中文名：悟空API网关（开源版），是eoLinker旗下的API网关，帮助企业进行API服务治理、API性能安全维护，为企业数字化赋能。**
该文件放置在**goku-ce-console/config**目录，cluster.yaml的配置示例：
```
cluster:
-
name: "GZ" # 机房主键，具有唯一性，仅支持英文（不区分大小写）、下划线、数字
title: "广州机房" # 机房名称，具有唯一性，用于控制台显示集群名称，支持中文、英文（不区分大小写）、下划线、数字
note: "从机房" # 机房备注，支持中文、英文（不区分大小写）、下划线、数字
db:
driver: "mysql" # 数据库类型，可选项：mysql
host: "127.0.0.1" # 数据库主机地址
port: 3306 # 数据库端口号
userName: "root" # 用户名
password: "123456" # 数据库密码
database: "goku_ce" # 数据库名称
redis:
mode: "sentinel" # redis模式，可选项：stand/sentinel/cluster
addrs: "127.0.0.1:6379,127.0.0.1:6380" # sentinel模式下addrs为sentinel地址，多个地址间用英文逗号隔开
password: "123456" # redis密码
dbIndex: 0 # redis序号，非必填，默认值为0
masters: mymaster # 当mode为sentinel时，该选项必填
-
name: "BJ"
title: "北京机房"
note: "主机房"
db:
driver: "mysql"
host: "127.0.0.1"
port: 3306
userName: "root"
password: "123456"
database: "goku_ce"
redis:
mode: "stand"
addrs: "127.0.0.1:6379" # stand、cluster模式下addrs为redis地址，多个地址间用英文逗号隔开
password: "123456"
dbIndex: 0
```
GoKu API Gateway CE，支持OpenAPI与微服务管理，支持私有云部署，实现API转发、请求参数转换、数据校验等功能，提供图形化界面管理，能够快速管理多个API网关，提高API业务安全性。
#### 3. 启动控制台
## 相关链接
启动控制台前，需要先给予对应文件正确的权限：
（1）进入goku-ce-console文件夹，给予 **gateway-console** 文件执行权限：
* 官方网站：https://www.eolinker.com/#/product/agw
chmod +x gateway-console
* 教程文档：https://help.eolinker.com/#/tutorial/?productID=14
（2）进入goku-ce-console文件夹，给予 **export** 文件夹执行权限：
* Github：https://github.com/eolinker/GoKu-API-Gateway
chmod -R 777 export
## 特性
然后通过以下命令在后台执行gateway-console（首次执行加上用户名及密码参数）
1. **免费且开源**：GoKu API Gateway秉承开源精神，是国内第一个企业开源的API接口网关，为广大的开发、运维以及管理人员提供专业的产品。
* 首次安装
2. **多种鉴权方式**：支持Basic 认证、API Key授权、IP认证、无认证等方式。
```
nohup ./gateway-console -u admin -p 123456 > gateway-console-"$(date "+%Y-%m-%d_%H_%M_%S")".log 2>&1 &
```
**注**：**-u**后加**管理员用户名**，**-p**后加**管理员密码**，管理员账号信息用于登录网关控制台，请注意妥善保管。
3. **支持Open API**：不同账户拥有独立的访问密钥。
* 非首次安装
4. **权限管理**：可针对不同策略组设置流量控制策略，包括访问QPS、访问总次数、访问IP、访问时间段等
```
nohup ./gateway-console > gateway-console-"$(date "+%Y-%m-%d_%H_%M_%S")".log 2>&1 &
```
5. **请求转发**：默认支持http rest路由。
#### 4. 访问控制台
6. **IP黑白名单**：支持全局IP白名单、也可自定义某个接口的IP白名单。
在浏览器中输入**IP/域名+端口号**，进入网关控制台页面：
7. **数据整形**：支持参数的转换与绑定，支持formdata、raw数据。
注：控制台的端口号为 **goku.conf** 中的 **listen_port** 字段
8. **配置网关**：支持 **GoKu-UI** 与 **配置文件** 修改网关配置。
![](http://data.eolinker.com/course/bNrMsZs20920fa41cd6b3fd5fee98c7e23d76e0922978af)
9. **快速部署**：仅需要一个go环境即可安装运行。
至此，您已成功安装好GoKu网关控制台。
## 图片介绍
### 安装单个网关节点
![](http://data.eolinker.com/course/a9l9ZzQfe7cfc0f93578629db01a1a3197864dd51fa9dab)
#### 1. 服务器导入节点安装包
![](http://data.eolinker.com/course/3KDiWxscb527a460477f5bbb95fc3db6c09426c47de96f1)
（1）将获得的节点安装包压缩文件goku-node导入到服务器中。
![](http://data.eolinker.com/course/pRMJNTb1974cd4d502bf17f5b477b236cf5c090496af571)
（2）给予gateway-node可执行权限：
## 更新日志
```
chmod +x gateway-node
```
#### V2.1.4（2018/9/7）
新增：
其他节点操作类似，先在相应服务器放置网关文件，然后按照第2步依次在控制台新增并启动网关节点。
1. 策略ID参数支持放在Header。
#### 2.在控制台添加并启动节点
说明：
（1）登录控制台，点击一级导航的 **集群管理**，进入相应的集群：
通过网关访问的请求地址注意事项：
* 若策略ID放头部，则完整请求路径为：**网关IP：端口号/网关别名/接口路径**，策略ID的Header字段名为：**Strategy-Id**。
* 若策略ID放URI，则完整请求路径为：**网关IP：端口号/网关别名/策略ID/接口路径**。
![](http://data.eolinker.com/course/Wi3hSZzece73986c4714431437a678ffe5ba86c2e21cc54)
#### V2.1.3（2018/5/30）
新增：
（2）为不同集群 **添加节点** ：
1. 支持rest路由。
![](http://data.eolinker.com/course/rlWf1dI806427cc64c4b73af34dba35a758a4d9f21e86fc)
#### V2.1.2（2018/5/24）
修复：
（3）添加节点需要填写以下信息：
1. 修复网关后端服务返回请求头部重复。
* 选择分组
* 网关文件路径：可获取到**goku-node**已编译文件的目录，一般放置在**goku-ce-node**目录下
* 节点名称：用于标识服务器节点名称
* 节点IP：受控节点IP
* 节点端口：网关受控端监听的端口
#### V2.1.1（2018/5/22）
修复：
> 注意事项：
> **节点IP**字段填写**内网IP或本地IP**
> 若配置文件（goku.conf）中的**admin_bind**字段值IP部分为**127.0.0.1**或**localhost**，此处节点IP必须填写**127.0.0.1**
1. 修复流量控制方案修改后写入配置文件错误的问题;
2. 修复当接口、方案为最后一个时，删除失败的问题。
（4）启动节点：
#### V2.1.0（2018/5/21）
新增：
节点新建成功后处于 **未运行** 的状态，如需节点生效需要手动启动节点：
1. 支持UI管理界面；
2. UI新增网关监控信息；
3. UI支持对网关进行开启、重载、重启和关闭操作；
4. 接口分组，即配置文件的api_group.conf新增字段"cancel_default_group"，非必填，默认为false。
```
./run.sh {start|stop|reload|restart|force-reload} [admin url] [port]
```
此处的**admin url**值与配置文件（goku.conf）中的**admin_bind**字段值一致。
#### V2.0.3（2018/5/14）
新增：
示例：
```
./run.sh start 127.0.0.1:7005 7702
```
1. 支持form-data格式下文件传输；
2. 接口配置文件弃用proxy_body_type、proxy_body_desc字段，启用is_raw字段用于支持raw数据转发。
启动后，进入节点管理页面，若节点的状态显示为 **运行中**，则节点正常启动：
优化：
![](http://data.eolinker.com/course/AaFng1U9eff6d6d2e3fb483a44283a8ee5b6a0b756c978b)
1. 基于HttpRouter优化路由转发性能。
# 企业支持
Goku API Gateway EE（企业版本）拥有更强大的功能、插件库以及专业的技术支持服务，如您需要了解可以通过以下方式联系我们。
- **中国大陆服务支持电话**：400-616-0330 法定工作日（9:30-18:00）
- **申请企业版免费试用及演示**：[预约试用](https://wj.qq.com/s2/2150032/4b5e "预约试用")
- **市场合作邮箱**：market@eolinker.com
- **购买咨询邮箱**：sales@eolinker.com
#### V2.0.2（2018/5/7）
修复：
# 关于我们（EOLINKER）
EOLINKER 是领先的 API 管理服务供应商，为全球超过3000家企业提供专业的 API 研发管理、API自动化测试、API监控、API网关等服务。是首家为ITSS（中国电子工业标准化技术协会）制定API研发管理行业规范的企业。
1. 修复请求路径带query参数时，路径匹配失败的问题；
2. 修复proxy_method配置必须大写的问题，现支持不区分大小写。
官方网站：[https://www.eolinker.com](https://www.eolinker.com "EOLINKER官方网站")
免费下载PC桌面端：[https://www.eolinker.com/pc/](https://www.eolinker.com/pc/ "免费下载PC客户端")
#### V2.0.1（2018/5/4）
优化：
# 授权协议
```
Copyright 2017-2019 Eolinker Inc.
1. 优化网关的错误提示。
Licensed under the GNU General Public License v3.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.gnu.org/licenses/gpl-3.0.html
修复：
1. 修复访问网关根路径时，报越界错误。
#### V2.0.0（2018/5/4）
新增：
1. 通过配置文件修改网关配置；
2. 新增全局IP黑白名单；
3. 参数新增支持json类型。
优化：
1. 架构优化，减少第三方依赖，提升网关性能；
2. 弃置mysql、redis数据库的使用，改用配置文件方式读取文件配置。
#### V1.0.3（2018/4/20）
修复：
1. 修复“鉴权方式”编辑页错位问题。
#### V1.0.2（2018/4/19）
新增:
1. “接口分组”与“接口详情”可选择拼接网关地址与策略组id，方便查看请求地址。
修复：
1. “鉴权方式”里API Key显示错位问题;
2. 修复mysql5.7环境下，sql脚本执行失败;
3. 修复访问网关后端服务时，请求提示错误的问题。
#### V1.0.1（2018/4/17）
修复：
1. 某个脚本的编码错误。
#### V1.0.0(2018/4/17)
新增：
1. “网关概况”新增监控信息，方便监控API运行状况，包括：请求总数、成功请求数、失败请求数、每分钟实时访问次数等；
2. “权限控制”新增策略组，每个策略组下包括鉴权方式、IP黑白名单、流量控制三大模块；
3. 强化鉴权方式，包括Basic Auth、API Key、无认证；
4. 强化流量控制，支持允许访问时间段与禁止访问时间段；
5. 强化流量控制，支持设置每秒最大访问次数、每分钟最大访问次数、每小时最大访问次数、每天最大访问次数。
优化：
1. 全面优化界面；
2. 优化访问性能。
其他：
1. 加入开源声明。
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.
```
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或