Goku API Gateway 技术文档

1. 安装指南

1.1 系统要求

• 操作系统: Linux/Windows/macOS
• 内存: 至少2GB
• 存储: 至少100MB可用空间
• 网络: 需要访问互联网以下载依赖

1.2 安装方式

方式一: Docker安装(推荐)

# 安装控制台
docker pull eolinker/goku-api-gateway-ce-console

# 安装网关节点
docker pull eolinker/goku-api-gateway-ce-node

方式二: 源码编译

1. 安装Go语言环境(1.13+)
2. 克隆项目仓库

git clone https://github.com/eolinker/goku-api-gateway.git

3. 编译项目

cd goku-api-gateway
make build

方式三: 二进制包安装

1. 从GitHub Releases页面下载对应平台的二进制包
2. 解压并配置环境变量

2. 项目使用说明

2.1 启动服务

# 启动控制台
./goku-console start

# 启动网关节点
./goku-node start

2.2 访问控制台

1. 浏览器访问 http://localhost:8900
2. 使用默认账号登录(admin/admin)

2.3 基本功能配置

1. API管理: 添加、编辑、删除API
2. 策略管理: 配置访问控制策略
3. 负载均衡: 配置后端服务集群
4. 监控面板: 查看API调用统计

3. 项目API使用文档

3.1 开放API基础信息

• 基础路径: /api/v1
• 认证方式: Basic Auth或API Key

3.2 核心API接口

3.2.1 API管理

POST /api/v1/apis
Content-Type: application/json

{
  "name": "示例API",
  "path": "/example",
  "methods": ["GET"],
  "targets": [{
    "target": "http://backend-service",
    "weight": 100
  }]
}

3.2.2 策略管理

POST /api/v1/strategies
Content-Type: application/json

{
  "name": "示例策略",
  "auth_type": "api_key",
  "apis": ["示例API"]
}

3.2.3 监控数据获取

GET /api/v1/monitor/apis

4. 项目安装方式详解

4.1 Docker-Compose部署(生产推荐)

version: '3'
services:
  console:
    image: eolinker/goku-api-gateway-ce-console
    ports:
      - "8900:8900"
    environment:
      - DB_HOST=mysql
      - DB_USER=root
      - DB_PASSWORD=password

  node:
    image: eolinker/goku-api-gateway-ce-node
    ports:
      - "8000:8000"
    depends_on:
      - console

  mysql:
    image: mysql:5.7
    environment:
      - MYSQL_ROOT_PASSWORD=password
      - MYSQL_DATABASE=goku

4.2 集群部署建议

1. 控制台: 1-2节点(高可用)
2. 网关节点: 根据流量水平扩展
3. 数据库: MySQL主从或集群
4. 缓存: Redis集群

4.3 配置文件说明

主要配置文件位于conf/目录下:

• console.conf: 控制台配置
• node.conf: 网关节点配置
• plugin/: 插件配置目录