❤️❤️❤️❤️❤️❤️ 我们已经正式推出微信小程序,在微信中搜索 TrendForge Pro 即可使用小程序,如果使用 Telegram 请搜索 trendforge_tg ❤️❤️❤️❤️❤️❤️

学习路径指南
难度等级
入门
预计时长
1-2天
适合人群
零基础或初学者,对Go语言和大模型API管理感兴趣的开发者、系统管理员

学习目标:学会使用New API搭建和配置LLM网关,统一管理多种大模型API,实现密钥分配、权限控制和用量监控。

前置知识

基础计算机操作 了解

能够使用命令行终端,理解文件路径和基本网络概念

Docker基础 了解 (可选)

理解容器化概念,会运行简单的Docker命令(如docker run)

API基础知识 了解 (可选)

知道什么是API、API密钥、HTTP请求(GET/POST)

学习步骤

1

环境准备

30分钟

安装Docker和Docker Compose

根据操作系统(Windows/Mac/Linux)下载并安装Docker Desktop或Docker Engine,并确保Docker Compose可用

在终端运行docker --version和docker compose version验证安装成功

创建项目目录

在本地创建一个新文件夹(如new-api-demo),用于存放New API的配置和数据

建议使用英文路径,避免中文或空格

2

快速入门:部署New API

1小时

使用Docker Compose启动服务

在项目目录下创建docker-compose.yml文件,内容参考README中的代码块,然后运行docker compose up -d启动服务

确保端口3000未被占用,启动后访问http://localhost:3000

验证服务运行状态

打开浏览器访问http://localhost:3000,看到登录/注册页面即表示部署成功

如果无法访问,检查Docker容器是否正常运行:docker ps

3

核心功能:配置和使用

2-3小时

注册管理员账号并登录

首次访问时注册一个管理员账号,登录后进入管理后台

妥善保管账号密码,这是系统最高权限

添加上游API密钥

在管理后台的'渠道'或'上游'页面,添加你的OpenAI、Claude等API密钥,配置模型映射

确保密钥有效且符合上游服务条款,建议先添加一个测试密钥

创建用户和令牌

在'用户'页面创建新用户,在'令牌'页面生成API令牌,并设置模型访问权限和配额

令牌相当于New API的'二级密钥',用于客户端调用

测试API调用

使用curl或Postman等工具,用生成的令牌调用New API的聊天接口(如/v1/chat/completions),验证是否成功转发到上游

示例命令:curl http://localhost:3000/v1/chat/completions -H "Authorization: Bearer 你的令牌" -d '{"model":"gpt-4","messages":[{"role":"user","content":"Hello"}]}'

4

进阶功能:监控与成本核算

1-2小时

查看数据仪表盘

在管理后台的'仪表盘'页面,查看API调用次数、延迟、错误率等统计数据

仪表盘可以帮助你了解使用情况和性能瓶颈

配置用量和计费

在'计费'或'配额'页面,为不同用户或令牌设置额度,开启按请求计费功能

计费功能适用于内部管理或授权客户场景,需确保合法合规

设置模型限制和路由

在'模型'或'渠道'配置中,限制特定用户只能使用某些模型,配置加权随机路由和自动重试

合理配置路由可以提高服务稳定性

5

生产环境部署

1-2小时

配置外部数据库

将默认的SQLite替换为MySQL或PostgreSQL,确保数据持久化和高可用

在docker-compose.yml中设置SQLDSN环境变量指向外部数据库

配置环境变量

设置SESSIONSECRET、REDISCONNSTRING等关键环境变量,优化性能和安全

SESSIONSECRET必须设置,否则多机部署时登录状态会不一致

启用HTTPS和反向代理

使用Nginx或Caddy为New API配置HTTPS和域名,保障通信安全

生产环境务必使用HTTPS,避免API密钥泄露

推荐资源

New API 官方文档 必看

包含部署指南、环境变量配置、API文档和常见问题

New API GitHub仓库 推荐

项目源代码、Issue追踪和最新更新

Docker入门教程 推荐

学习Docker基础操作,帮助理解部署过程

New API 交流频道 可选

在官方文档中查找社区链接,与其他用户交流经验

学习路径常见错误

1

忘记挂载/data目录导致数据丢失

在Docker命令或docker-compose.yml中务必使用-v参数挂载/data目录到宿主机持久化目录

2

未设置SESSIONSECRET导致多机部署登录异常

在多机部署时必须设置SESSIONSECRET环境变量,且所有节点使用相同的值

3

使用无效或过期的上游API密钥

确保上游API密钥有效且未过期,定期检查密钥状态

4

直接暴露New API到公网未配置HTTPS

生产环境必须使用反向代理(如Nginx)配置HTTPS,避免明文传输API密钥

5

忽略合规要求直接用于公开服务

若用于公开生成式AI服务,必须完成备案、许可、内容安全等法律义务,否则可能违法

学习路径下一步步骤

学完基础后,可以继续探索:集成更多模型(如Midjourney、Suno)、使用OIDC统一认证、配置自定义上游端点、开发插件或二次开发New API源码。

助手