G-Master API

自托管 AI 网关、中转服务与模型资产管理面板

简体中文（默认） | 繁體中文 | 日本語 | Français

快速开始 • 主要特性 • 部署方式 • 文档 • 更新日志 • 帮助与反馈

项目说明

Important

• G-Master API 面向 自托管、多模型统一接入、用户与令牌管理、渠道管理、计费与控制台运营 场景。
• 当前公开站点为 https://gmapi.fun，OpenAI 兼容基址为 https://gmapi.fun/v1，用户/管理接口基址为 https://gmapi.fun/api。
• 若你计划对公网开放服务，请自行评估合规、资费、安全、日志留存、备份和运维责任。

当前源码稳定基线：v1.0.0-rc.10-GM.5

Note

v1.0.0-rc.10-GM.5 继续打磨 Gaster Code 产品介绍页，补齐浅色/深色模式的语义色、移动端标题尺度、下载区排版和滚动 reveal 动效，同时保留 v1.0.0-rc.10-GM.4 的科技产品页结构、release-only 下载资产说明、令牌管理、使用日志工作台、操练场三栏调试、Gaster Code 桌面端账号中心、异步图片生成、模型健康度日志兜底与现有 G-Master 控制台体验。

G-Master API 主要能力

• 对外产品名统一为 G-Master API，仓库链接、公共文案、主页与文档入口都以当前品牌为准。
• 默认部署方式为 直接构建当前仓库源码，便于掌控前端、后端、文档和发布产物。
• 默认服务名、容器名、systemd 服务名统一为 g-master-api。
• 面向当前业务保留 标准用户组 / VIP用户组 等分组策略，以及相关充值升级逻辑。
• 新增 Gaster Code 桌面端网页登录授权接口，桌面端可通过浏览器登录或注册、PKCE 授权码、本地回调与专用 Provider Token 完成接入。
• 首页顶栏提供 Gaster Code 详情入口，面向所有用户展示桌面端能力、安装包选择、自动更新说明，并统一跳转到公开 release-only 下载仓库。
• 控制台与模型广场提供模型健康度、性能指标和热度排行，用于观察渠道延迟、成功率、TPS 和模型用量趋势；性能指标采集默认开启，可通过 perf_metrics_setting.enabled 显式关闭。
• 使用日志保留本地与供应商 Request ID，钱包/订阅页和渠道编辑器提供紧凑状态摘要，便于运营排查计费、订阅抵扣和渠道配置问题。
• 渠道亲和支持从请求上下文、请求体 gjson path 和入口请求头提取 key，可按第三方集成的自定义 Header 固定渠道并统计缓存命中。
• 订阅套餐支持 Stripe、Creem、易支付和 Waffo Pancake 购买入口；Waffo Pancake 订阅回调会走独立订单校验，避免和普通充值订单串单。
• 维护独立的 GitHub Release、GHCR 镜像、Apifox 导入产物与中文优先文档。

快速开始

使用 Docker Compose（推荐）

# 克隆项目
git clone https://github.com/HereditaryDog/G-Master-API.git
cd G-Master-API

# 复制环境变量模板
cp .env.example .env

# 启动服务
docker compose up -d --build

启动完成后，访问 http://127.0.0.1:3000 即可进入初始化流程。

升级当前部署

git pull
docker compose up -d --build

回滚到指定版本

git checkout <commit-or-tag>
docker compose up -d --build

Tip

升级或回滚前，建议先备份数据库与 data/、logs/ 目录。

文档

分类	链接	说明
AI 客户端配置文档	gmapi.fun/docs/ai-client	Apifox 公开文档入口
OpenClaw 英文页	gmapi.fun/docs/openclaw-en	Apifox OpenClaw 英文配置页
部署说明	docs/installation/BT.md	宝塔 / VPS 场景说明
Gaster Code 桌面端授权	docs/gaster-code-desktop-auth.md	桌面端网页登录、Provider Token、下载入口与更新说明
图片生成异步任务	docs/image-generation-async.md	gpt-image-2 等长耗时图片模型的创建任务与轮询接口
接口整理	docs/apifox/README.md	Apifox 导入与接口整理
贡献指南	CONTRIBUTING.md	提交 PR、Issue 与协作约定
更新日志	CHANGELOG.md	版本历史与发布记录
授权与致谢	ACKNOWLEDGMENTS.md	授权、许可证与归属说明
安全策略	.github/SECURITY.md	漏洞反馈与安全提醒

主要特性

网关与协议兼容

• 兼容 OpenAI Chat Completions、Responses、Realtime 等主流接口。
• 支持 Claude Messages、Google Gemini 原生格式，以及 Embeddings、Images、Audio、Video、Rerank 等能力。
• 支持模型映射、参数透传、渠道级能力控制与多模型统一路由。

控制台与运营能力

• 用户、令牌、渠道、模型、订阅、兑换码、分组、系统设置统一在同一套管理面板完成。
• 提供数据看板、日志查询、额度与成本展示、模型价格展示等运营能力。
• 支持 OAuth 登录、2FA、Passkey、访问限制、风控与多种支付/充值流程。
• 支持桌面端外部应用授权登录，不要求桌面端直接保存网页 Cookie 或长期保存用户密码。

Gaster Code 桌面端入口

• 公开页面：/gaster-code，顶栏位于“首页”之后，可在后台“顶栏管理”中控制显示状态。
• 下载入口：https://github.com/HereditaryDog/gaster-code-releases/releases/latest。
• 统一账号入口：POST /api/gaster-code/auth/start 支持 intent=login 与 intent=register；缺省按登录授权处理，注册完成后继续同一 PKCE 授权回调。
• 当前公开稳定安装包覆盖 macOS Apple Silicon 与 Windows x64，macOS updater 继续使用公开 ZIP 与 latest-mac.yml，Windows updater 使用 latest.yml。
• 页面采用更宽松的科技产品页叙事，补齐浅色/深色主题、移动端排版和滚动动效，说明本地项目理解、代码编辑与调试、终端工作流、G-Master API 模型接入、桌面端会话、绘图与 IM 远程入口等能力。
• 公开下载仓库只分发安装包、ZIP 更新包、updater 元数据和未签名 macOS 安装说明，不暴露 Gaster Code 私有主仓库。
• 绘图页可使用 POST /v1/images/generations/async 创建图片任务，再轮询 /v1/images/jobs/{task_id}，避免长连接等待导致 524；异步队列会对上游 504/524 超时执行受控重试，并保留客户端传入的原始提示词。

存储与部署兼容

• 支持 SQLite、MySQL、PostgreSQL。
• 支持 Redis 与内存缓存组合。
• 默认提供源码构建的 Docker Compose 部署方式，适合本地验收与服务器部署。

G-Master 分支交付层

• 中文优先的仓库文档、对外主页与文档门户。
• 独立 GitHub Release 与 GHCR 镜像发布链路。
• 独立维护的 Apifox 导入文件、公共链接和品牌资源。

部署方式

1. 本地或服务器源码部署

适合需要完整保留当前仓库品牌资源、前端页面和最新文档的场景。

docker compose up -d --build

2. GitHub Release 成品

• 发布页：https://github.com/HereditaryDog/G-Master-API/releases
• 适合下载预编译二进制做自定义部署。

3. GHCR 镜像

• 镜像地址：ghcr.io/hereditarydog/g-master-api:latest
• 适合纳入现有 CI/CD 或镜像仓库流程。

4. 宝塔 / 腾讯云 / Cloudflare

• 宝塔部署说明见 docs/installation/BT.md
• 当前公开站点接入了 Cloudflare DNS / TLS
• 若沿用 gmapi.fun 域名，可继续复用现有公开接入地址

仓库结构

• router/ HTTP 路由入口
• controller/ 控制器与请求处理
• service/ 业务逻辑
• model/ GORM 数据模型与数据库访问
• relay/ 模型中转、协议兼容与渠道适配
• web/ React 前端控制台
• docs/ 部署文档、Apifox 资料与说明
• bin/ 辅助脚本、备份和部署工具

常用文件

• docker-compose.yml
• .env.example
• VERSION
• CHANGELOG.md
• ACKNOWLEDGMENTS.md
• docs/installation/BT.md

帮助与反馈

• 问题反馈：https://github.com/HereditaryDog/G-Master-API/issues
• 版本发布：https://github.com/HereditaryDog/G-Master-API/releases
• 安全问题：https://github.com/HereditaryDog/G-Master-API/security/advisories/new

提交 Issue 之前，建议先确认：

• 是否已经阅读 README、部署说明 与 更新日志
• 是否能稳定复现问题
• 是否已经确认不是已知配置、网络或服务商行为

许可证与致谢

本项目继续使用 AGPL-3.0。

授权与归属说明请见 ACKNOWLEDGMENTS.md。如果你要二次分发、商用或对外提供网络服务，请先确认自己理解 AGPL 在网络服务场景下的义务。

---

如果这个仓库对你有帮助，欢迎 Star。