1
项目来源与背景
MyAPI 是基于开源大模型 API 中转网关 new-api（基于上游 v1.0.0-rc.41 / 973cf8ef4）进行深度定制的衍生开源项目。
官方 GitHub 仓库：axzcnzxis/myapi
🌱 传承基础能力
- 全面兼容 OpenAI 标准接口协议与生态客户端
- 渠道故障自动熔断重试与多 Key 加权轮询
- 多租户配额控制、余额扣除与充值逻辑
- 前后端一体化交付，原生支持 SSE 流式高速转发
✨ MyAPI 专属功能增强
- 平台公告系统：支持通知中心与弹窗，带 30 秒后台状态机
- 用户/订阅多分组：支持单个账号同时加入多个分组权限
- 余额支付白名单：精细化控制允许扣除余额的模型范围
- 站内文档集成：控制台
/docs路由直接渲染项目说明
2
安装与部署教程
💡 环境准备：服务器请预先安装好
Docker 与 Docker Compose，并在云服务器安全组放行服务端口 32180。
方案 A：一键自动化脚本部署
推荐 · 最简
项目内置了自动化安装脚本，可一键完成环境配置、拉取官方镜像并自动随机生成高强度密钥保存至 .env：
Shell
bash <(curl -sL https://raw.githubusercontent.com/axzcnzxis/myapi/main/install.sh)
注：若服务器拉取外网脚本受限，可先手动克隆仓库后本地执行：
git clone https://github.com/axzcnzxis/myapi.git && cd myapi && chmod +x install.sh && ./install.sh
方案 B：Docker Compose 自定义编排
标准生产方案
在服务器工作目录创建 docker-compose.yml 配置文件（默认集成 Redis 缓存与持久化卷）：
docker-compose.yml
version: '3.8'
services:
myapi:
image: ghcr.io/axzcnzxis/myapi:latest
container_name: myapi
restart: always
ports:
- '32180:3000'
volumes:
- ./data:/data
- ./logs:/app/logs
environment:
- PORT=3000
- REDIS_CONN_STRING=redis://redis:6379/0
- SESSION_SECRET=change_this_to_random_secret_key
- THEME=default
- TZ=Asia/Shanghai
depends_on:
- redis
redis:
image: redis:7-alpine
container_name: myapi-redis
restart: always
volumes:
- ./redis_data:/data在配置文件所在目录下启动容器集群：
Shell
docker compose up -d
3
系统访问与初始化配置
服务成功启动后，即可在浏览器直接访问 Web 管理控制台：
- 后台访问地址：
http://<你的服务器IP>:32180（若绑定域名可配置 Nginx 反向代理至该端口） - 初始超级管理员账号：
root - 初始超级管理员密码：
123456（或按首次访问向导提示自行设置）
📌 初始化密码设置说明：首次在浏览器打开管理后台时，系统会进入初始化引导流程，需要在初始化向导界面中自行完成管理员密码的设置。若系统已默认生成密码
123456，成功登录后也请务必在右上角「个人设置」中立即修改。
⚠️ 安全警示：若存在默认初始密码，切勿使用弱口令对外开放服务。请及时修改密码并绑定安全邮箱，以防被恶意扫描利用。
4
核心业务使用指南
-
添加模型渠道 (Channels)：
进入后台「渠道」页面点击添加，选择对应的提供商类型（如 OpenAI、Claude 等），填入 API 密钥与代理地址，并指定所属分组（如default）。 -
生成客户端调用令牌 (Tokens)：
进入「令牌」页面添加令牌，设置可用额度上限、可用模型白名单与对应分组。生成后即可复制专属的sk-xxxxxxxx...密钥。 -
客户端请求调用对接：
系统完全兼容 OpenAI API 规范。只需在 NextChat、ChatBox 或第三方程序中将 API 基础地址设置为http://<服务器IP>:32180/v1即可。
终端 cURL 测试调用示例：
cURL
curl http://localhost:32180/v1/chat/completions -H "Content-Type: application/json" -H "Authorization: Bearer sk-your_token_here" -d '{
"model": "gpt-4o-mini",
"messages": [{"role": "user", "content": "你好！"}]
}'
5
服务卸载与数据清理
若需要停止服务、迁移服务器或彻底清除部署痕迹，可执行以下命令：
1. 停止并销毁运行中的容器：
Shell
# 若通过 Docker Compose 部署：
docker compose down
# 若通过单容器部署：
docker stop myapi && docker rm myapi2. 彻底清除持久化数据与配置文件（数据将永久删除）：
Shell
rm -rf ./data ./logs ./redis_data .env docker-compose.yml