New API是基于One API二次开发的新一代大模型网关与AI资产管理系统，专为开发者和企业提供统一的AI服务接入和管理解决方案。本教程将带你从零开始，快速掌握这个强大的开源项目。

【免费下载链接】new-api 基于One API的二次开发版本，仅供学习使用！ 项目地址: https://gitcode.com/gh_mirrors/ne/new-api

为什么选择New API？

在AI应用爆炸式增长的今天，管理多个大模型服务变得复杂而繁琐。New API通过统一的网关接口，让你能够：

• 集中管理所有主流AI模型的API访问
• 实现智能路由和负载均衡
• 提供完整的用户权限和计费系统
• 支持多语言国际化界面
• 具备企业级的安全和监控能力

核心功能概览

1. 多模型统一接入

New API支持OpenAI、Claude、Gemini、Midjourney等主流AI服务，通过标准化接口简化开发流程。

2. 智能路由与负载均衡

自动分配请求到最优渠道，支持失败重试和权重配置，确保服务高可用性。

3. 完整的用户管理体系

提供用户注册、令牌管理、权限控制等功能，支持多种登录方式包括OIDC统一认证。

4. 灵活的计费系统

支持按次计费、缓存计费策略，集成易支付和Stripe等支付渠道。

5. 实时监控与分析

内置数据看板和统计分析功能，帮助管理者了解系统运行状态和使用情况。

5步快速部署指南

第一步：环境准备

确保你的系统满足以下要求：

• Docker和Docker Compose
• 至少2GB内存
• 支持SQLite或MySQL/PostgreSQL数据库

第二步：获取项目代码

git clone https://gitcode.com/gh_mirrors/ne/new-api.git
cd new-api

第三步：配置数据库

编辑docker-compose.yml文件，根据需求配置数据库连接：

environment:
  - SQL_DSN=postgresql://root:your_password@postgres:5432/new-api
  - REDIS_CONN_STRING=redis://redis

第四步：启动服务

docker-compose up -d

第五步：访问系统

打开浏览器访问 http://localhost:3000，使用默认账户登录系统。

核心模块深度解析

控制器层（Controller）

控制器负责处理HTTP请求和业务逻辑，包含用户管理、渠道配置、计费处理等核心功能：

• 用户控制器：处理用户注册、登录、令牌管理
• 渠道控制器：管理AI服务渠道的添加、测试和配置
• 计费控制器：处理充值、消费记录和费率设置
• 任务控制器：管理异步任务和批处理操作

中继服务（Relay）

中继模块是系统的核心，负责将请求转发到不同的AI服务提供商：

// 示例：AI中继处理
func AIRelayHandler(c *gin.Context) {
    // 请求验证和预处理
    // 渠道选择和负载均衡
    // 请求转发和响应处理
}

支持的中继类型包括：

• 标准AI接口
• Claude Messages格式
• Gemini聊天接口
• Midjourney图像生成
• 音频和视频处理

数据模型（Model）

数据层定义系统核心数据结构：

• 用户模型：存储用户信息和权限设置
• 渠道模型：管理AI服务提供商配置
• 令牌模型：处理API密钥和访问控制
• 日志模型：记录系统操作和API调用

服务层（Service）

服务层包含业务逻辑实现：

• 配额服务：管理用户使用额度
• 渠道选择服务：智能路由算法
• 价格计算服务：实时费用计算
• 消息通知服务：系统通知和警报

实战开发示例

添加自定义AI服务

要在New API中添加新的AI服务支持，只需实现相应的中继适配器：

// 在relay/channel/目录下创建新的适配器
package customai

import (
    "github.com/gin-gonic/gin"
)

func CustomAIAdaptor(c *gin.Context) {
    // 实现请求转换逻辑
    // 处理身份验证
    // 转发请求并处理响应
}

配置智能路由策略

通过修改运营设置，可以配置渠道的权重和优先级：

# 环境变量配置示例
FAILOVER_RETRIES=3
CHANNEL_SELECTION_STRATEGY=weighted_random

常见问题解决

部署问题

Q: 容器启动失败怎么办？ A: 检查数据库连接字符串和端口冲突，确保所有服务正常启动。

Q: 如何查看日志？ A: 使用docker logs new-api查看容器日志，日志文件位于/app/logs目录。

配置问题

Q: 如何修改默认端口？ A: 设置环境变量PORT=你的端口号或修改docker-compose.yml中的端口映射。

Q: 如何配置HTTPS？ A: 建议使用Nginx反向代理配置SSL证书。

性能优化

Q: 如何提高并发性能？ A: 启用Redis缓存，调整SYNC_FREQUENCY参数，优化数据库索引。

最佳实践建议

1. 生产环境部署：务必修改默认密码和密钥，启用HTTPS
2. 监控设置：配置日志监控和性能指标收集
3. 备份策略：定期备份数据库和关键配置文件
4. 安全加固：设置防火墙规则，限制管理界面访问
5. 版本升级：关注项目更新，及时修复安全漏洞

扩展开发指南

New API采用模块化设计，易于扩展新功能：

• 插件开发：在适当目录添加新的控制器和服务
• 界面定制：修改web/src目录下的前端代码
• API扩展：在router目录添加新的路由端点
• 中间件开发：在middleware目录添加自定义中间件

总结

New API作为一个功能完整的大模型网关系统，为开发者提供了强大的AI服务管理能力。通过本教程，你应该已经掌握了系统的核心概念、部署方法和基本使用技巧。

无论是个人项目还是企业应用，New API都能帮助你快速构建稳定可靠的AI服务架构。建议从简单的单机部署开始，逐步深入了解各个模块的功能和配置选项。

记住，开源项目的优势在于社区支持，遇到问题时可以查阅项目文档或向社区寻求帮助。祝你使用愉快！

【免费下载链接】new-api 基于One API的二次开发版本，仅供学习使用！ 项目地址: https://gitcode.com/gh_mirrors/ne/new-api