resgateio/resgate

Resgate：实时API网关

镜像概述和主要用途

Resgate是一个基于Go语言开发的实时API网关，实现了RES协议，使用NATS服务器作为消息系统。它是一个轻量级服务器，可用于创建REST、实时和RPC API，确保所有客户端之间的无缝同步。适用于构建具有实时功能的新REST API，或使用React、Vue.js、Modapp等响应式框架开发单页应用。

!Resgate架构图

核心功能和特性

• RES协议支持：基于RES协议实现客户端与服务端的实时通信
• NATS集成：使用NATS服务器作为高效的消息传递系统
• 多客户端同步：自动跟踪客户端请求的资源，数据变更时实时更新所有订阅客户端
• REST与实时结合：同时支持RESTful API和实时WebSocket通信
• 缓存机制：维护资源缓存以提高响应速度
• 跨语言支持：可与任何语言编写的微服务配合使用
• 轻量级部署：Docker镜像体积小（约10MB），资源占用低

使用场景和适用范围

• 构建需要实时数据更新的Web应用（如协作工具、实时仪表盘）
• 开发单页应用（SPA），需要保持客户端状态同步
• 设计微服务架构中的API网关层，统一接口并提供实时能力
• 实现多客户端（Web、移动应用）的数据同步

使用方法和配置说明

快速启动

使用Docker快速部署Resgate和NATS服务器：

bash
# 创建网络
docker network create res

# 启动NATS服务器
docker run -d --name docker.xuanyuan.run/nats -p 4222:4222 --net res nats

# 启动Resgate
docker run --name resgate -p 8080:8080 --net res docker.xuanyuan.run/resgateio/resgate --nats nats://nats:4222

示例项目

Resgate提供多种示例，涵盖不同使用场景：

命令行选项

服务器选项

安全选项

日志选项

通用选项

配置文件

Resgate支持JSON格式的配置文件，默认配置如下：

json
{
    "natsUrl": "nats://127.0.0.1:4222",
    "addr": "0.0.0.0",
    "port": 8080,
    "metricsPort": 0,
    "wsPath": "/",
    "apiPath": "/api",
    "requestTimeout": 3000,
    "apiEncoding": "json",
    "wsCompression": false,
    "allowOrigin": "*",
    "debug": false,
    "trace": false
}

使用配置文件启动：

bash
docker run --name resgate -p 8080:8080 --net res -v ./resgate.json:/resgate.json docker.xuanyuan.run/resgateio/resgate -c /resgate.json

运行注意事项

Resgate设计为在无法连接NATS服务器或连接丢失时退出。这允许客户端尝试重新连接到其他Resgate实例并恢复会话。可以使用以下脚本保持Resgate运行：

bash
#!/bin/bash
until docker start resgate; do
    echo "Resgate容器已退出，正在重启..." >&2
    sleep 2
done

协议规范

• RES协议 - 介绍和通用术语
• RES-Service协议 - 服务端实现指南
• RES-Client协议 - 客户端库开发指南

文档资源

完整文档和资源请访问Resgate.io，包括：

• 安装指南
• 配置说明
• 服务编写教程
• 扩展与缩放
• 客户端框架集成（React、Vue.js等）