heicode/new-api/README.md

TaijiAICloud Gateway (new-api)

这是 HeiCode 产品线中的平台侧网关工程，基于 new-api 深度改造，目标是让 HeiCode 客户端能够“浏览器登录后即用模型”。

本仓库角色

• 作为模型统一入口，管理渠道、用户、令牌、计费策略
• 提供 HeiCode 需要的授权桥接接口
• 输出标准模型发现能力（/v1/models）给客户端

HeiCode 相关新增能力

1) 浏览器登录授权入口

• GET /heicode/oauth/authorize
• GET /heicode/oauth/session

行为说明：

• 校验 redirect_uri 必须是 loopback（127.0.0.1 / localhost / ::1）
• 若用户未登录平台控制台，先引导登录
• 登录后签发或复用 HeiCode 专用 token
• 回跳本地客户端并携带 state 与 token

2) 客户端模型发现

• HeiCode 通过 GET /v1/models 拉取可用模型集合
• 客户端不再依赖硬编码模型列表

快速运行（本地 Docker）

cd new-api
docker compose -f docker-compose.yml -f docker-compose.override.yml up --build -d

查看服务状态：

docker compose ps
docker compose logs -f new-api

默认访问地址：http://localhost:3000

HeiCode 联调检查清单

• 平台已可正常登录 Web 控制台
• GET /heicode/oauth/authorize 返回流程可达
• GET /heicode/oauth/session 可反映登录态
• GET /v1/models 返回模型列表不为空
• HeiCode 客户端登录后可直接发起模型请求

目录关注点

• controller/heicode_oauth.go：HeiCode 授权与会话检测核心逻辑
• router/heicode-router.go：HeiCode OAuth 路由注册
• router/main.go：总路由接入点
• docker-compose.override.yml：本地开发构建入口

生产建议

• 强制 HTTPS 与可信证书
• 设置稳定的会话密钥与持久化存储
• 对授权回调、token 签发、模型探活增加审计日志
• 配置限流与告警，避免异常流量冲击

许可证与来源

本工程基于 new-api 上游能力演进，遵循对应许可证要求。企业使用前请完成内部合规审查。