oneapi与newapi的api控制文档

饭

2025-03-04

❗灵感一现

适用版本：
one-api v0.6.10
new-api v4.8.9.5

由 api.go 源码结合控制器方法生成。
由于只用到token令牌相关，所以其他API文档参数没有补全。请自行去 api.go 查看。

使用鉴权：
1.设置-个人设置-个人信息-生成系统访问令牌
2.将生成的令牌填入请求头Authorization中
Authorization:bearer xxxxxxxx
3.如果使用new-api，还需要在请求头中设置值为user_id
new-api-user：1

路径	方法	权限要求	描述
`/api/status`	GET	无	获取系统状态
`/api/models`	GET	用户	获取模型列表
`/api/notice`	GET	无	获取系统公告
`/api/about`	GET	无	获取关于信息
`/api/home_page_content`	GET	无	获取首页内容
`/api/verification`	GET	无	发送邮箱验证码
`/api/reset_password`	GET	无	发送重置密码邮件
`/api/user/reset`	POST	无	重置密码
`/api/oauth/github`	GET	无	GitHub OAuth认证
`/api/oauth/oidc`	GET	无	OIDC认证
`/api/oauth/lark`	GET	无	飞书认证
`/api/oauth/state`	GET	无	生成OAuth状态码
`/api/oauth/wechat`	GET	无	微信认证
`/api/oauth/wechat/bind`	GET	用户	绑定微信账号
`/api/oauth/email/bind`	GET	用户	绑定邮箱
`/api/topup`	POST	管理员	管理员充值
`/api/user/register`	POST	无	用户注册
`/api/user/login`	POST	无	用户登录
`/api/user/logout`	GET	无	用户登出
`/api/user/dashboard`	GET	用户	获取用户仪表盘数据
`/api/user/self`	GET/PUT/DELETE	用户	获取/更新/删除个人信息
`/api/user/token`	GET	用户	生成访问令牌
`/api/user/aff`	GET	用户	获取推广码
`/api/user/topup`	POST	用户	用户充值
`/api/user/available_models`	GET	用户	获取可用模型列表
`/api/user/`	GET/POST/PUT	管理员	用户管理接口
`/api/user/search`	GET	管理员	搜索用户
`/api/user/:id`	GET/DELETE	管理员	获取/删除指定用户
`/api/user/manage`	POST	管理员	管理用户
`/api/option/`	GET/PUT	超级管理员	获取/更新系统选项
`/api/channel/`	GET/POST/PUT	管理员	渠道管理
`/api/channel/search`	GET	管理员	搜索渠道
`/api/channel/models`	GET	管理员	获取所有模型
`/api/channel/test`	GET	管理员	测试所有渠道
`/api/channel/test/:id`	GET	管理员	测试指定渠道
`/api/channel/update_balance`	GET	管理员	更新所有渠道余额
`/api/channel/update_balance/:id`	GET	管理员	更新指定渠道余额
`/api/channel/disabled`	DELETE	管理员	删除禁用的渠道
`/api/channel/:id`	GET/DELETE	管理员	获取/删除指定渠道
`/api/token/`	GET/POST/PUT	用户	令牌管理
`/api/token/search`	GET	用户	搜索令牌
`/api/token/:id`	GET/DELETE	用户	获取/删除指定令牌
`/api/redemption/`	GET/POST/PUT	管理员	兑换码管理
`/api/redemption/search`	GET	管理员	搜索兑换码
`/api/redemption/:id`	GET/DELETE	管理员	获取/删除指定兑换码
`/api/log/`	GET/DELETE	管理员	日志管理
`/api/log/stat`	GET	管理员	获取日志统计
`/api/log/self/stat`	GET	用户	获取个人日志统计
`/api/log/search`	GET	管理员	搜索所有日志
`/api/log/self`	GET	用户	获取个人日志
`/api/log/self/search`	GET	用户	搜索个人日志
`/api/group/`	GET	管理员	获取分组信息

获取系统状态
路径：/api/status
方法：GET
权限要求：无
描述：获取系统状态

获取模型列表
路径：/api/models
方法：GET
权限要求：用户
描述：获取模型列表

获取系统公告
路径：/api/notice
方法：GET
权限要求：无
描述：获取系统公告

获取关于信息
路径：/api/about
方法：GET
权限要求：无
描述：获取关于信息

获取首页内容
路径：/api/home_page_content
方法：GET
权限要求：无
描述：获取首页内容

发送邮箱验证码
路径：/api/verification
方法：GET
权限要求：无
描述：发送邮箱验证码

发送重置密码邮件
路径：/api/reset_password
方法：GET
权限要求：无
描述：发送重置密码邮件

重置密码
路径：/api/user/reset
方法：POST
权限要求：无
描述：重置密码

GitHub OAuth认证
路径：/api/oauth/github
方法：GET
权限要求：无
描述：通过 GitHub 进行 OAuth 认证

OIDC认证
路径：/api/oauth/oidc
方法：GET
权限要求：无
描述：通过 OIDC 进行认证

飞书认证
路径：/api/oauth/lark
方法：GET
权限要求：无
描述：通过飞书进行认证

生成OAuth状态码
路径：/api/oauth/state
方法：GET
权限要求：无
描述：生成用于 OAuth 认证的状态码

微信认证
路径：/api/oauth/wechat
方法：GET
权限要求：无
描述：通过微信进行认证

绑定微信账号
路径：/api/oauth/wechat/bind
方法：GET
权限要求：用户
描述：将当前账号与微信账号绑定

绑定邮箱
路径：/api/oauth/email/bind
方法：GET
权限要求：用户
描述：将当前账号与邮箱绑定

管理员充值
路径：/api/topup
方法：POST
权限要求：管理员
描述：管理员为用户充值额度
请求体示例：

{
  "user_id": 1,
  "quota": 100000,
  "remark": "充值 100000 额度"
}

用户注册
路径：/api/user/register
方法：POST
权限要求：无
描述：新用户注册

用户登录
路径：/api/user/login
方法：POST
权限要求：无
描述：用户登录系统

用户登出
路径：/api/user/logout
方法：GET
权限要求：无
描述：用户退出登录

获取用户仪表盘数据
路径：/api/user/dashboard
方法：GET
权限要求：用户
描述：获取用户的仪表盘统计数据

个人信息管理
路径：/api/user/self
方法：GET/PUT/DELETE
权限要求：用户
描述：获取、更新或删除个人信息

生成访问令牌
路径：/api/user/token
方法：GET
权限要求：用户
描述：生成用户的 API 访问令牌

获取推广码
路径：/api/user/aff
方法：GET
权限要求：用户
描述：获取用户的推广码信息

用户充值
路径：/api/user/topup
方法：POST
权限要求：用户
描述：用户进行充值操作

获取可用模型列表
路径：/api/user/available_models
方法：GET
权限要求：用户
描述：获取当前用户可以使用的模型列表

用户管理
路径：/api/user/
方法：GET/POST/PUT
权限要求：管理员
描述：管理系统用户

搜索用户
路径：/api/user/search
方法：GET
权限要求：管理员
描述：搜索系统中的用户

特定用户操作
路径：/api/user/:id
方法：GET/DELETE
权限要求：管理员
描述：获取或删除指定用户

批量用户管理
路径：/api/user/manage
方法：POST
权限要求：管理员
描述：批量管理用户

系统选项管理
路径：/api/option/
方法：GET/PUT
权限要求：超级管理员
描述：获取或更新系统配置选项

渠道管理
路径：/api/channel/
方法：GET/POST/PUT
权限要求：管理员
描述：管理 API 渠道

搜索渠道
路径：/api/channel/search
方法：GET
权限要求：管理员
描述：搜索系统中的渠道

获取所有模型
路径：/api/channel/models
方法：GET
权限要求：管理员
描述：获取所有可用的模型列表

测试渠道
路径：/api/channel/test
方法：GET
权限要求：管理员
描述：测试所有渠道的可用性

测试特定渠道
路径：/api/channel/test/:id
方法：GET
权限要求：管理员
描述：测试指定渠道的可用性

更新渠道余额
路径：/api/channel/update_balance
方法：GET
权限要求：管理员
描述：更新所有渠道的余额信息

更新特定渠道余额
路径：/api/channel/update_balance/:id
方法：GET
权限要求：管理员
描述：更新指定渠道的余额信息

删除禁用渠道
路径：/api/channel/disabled
方法：DELETE
权限要求：管理员
描述：删除所有已禁用的渠道

特定渠道操作
路径：/api/channel/:id
方法：GET/DELETE
权限要求：管理员
描述：获取或删除指定渠道

令牌管理
路径：/api/token/
方法：GET/POST/PUT
权限要求：用户
描述：管理 API 访问令牌

get：获取令牌列表

?p=0&size=10

post：创建令牌

{
    "name": "vrsdhi2222",
    "remain_quota": 500000,
    "expired_time": -1,
    "unlimited_quota": false,
    "model_limits_enabled": false,
    "model_limits": "",
    "allow_ips": "",
    "group": ""
}

put：更新令牌

{
  "status_only": false, // 是否只更新状态
  "name": "vrsdhi2222", // 令牌名称
  "remain_quota": 500000, // 剩余额度
  "expired_time": -1, // 过期时间
  "unlimited_quota": false, // 是否无限额度
  "model_limits_enabled": false, // 是否启用模型限制
  "model_limits": "", // 模型限制
  "allow_ips": "", // 允许的 IP 列表
  "group": "" // 分组
}

搜索令牌
路径：/api/token/search
方法：GET
权限要求：用户
描述：搜索 API 令牌

?keyword=vrsdhi2222

特定令牌操作
路径：/api/token/:id
方法：GET/DELETE
权限要求：用户
描述：获取或删除指定令牌

兑换码管理
路径：/api/redemption/
方法：GET/POST/PUT
权限要求：管理员
描述：管理系统兑换码

搜索兑换码
路径：/api/redemption/search
方法：GET
权限要求：管理员
描述：搜索系统兑换码

特定兑换码操作
路径：/api/redemption/:id
方法：GET/DELETE
权限要求：管理员
描述：获取或删除指定兑换码

日志管理
路径：/api/log/
方法：GET/DELETE
权限要求：管理员
描述：管理系统日志

获取日志统计
路径：/api/log/stat
方法：GET
权限要求：管理员
描述：获取系统日志统计信息

获取个人日志统计
路径：/api/log/self/stat
方法：GET
权限要求：用户
描述：获取个人日志统计信息

搜索系统日志
路径：/api/log/search
方法：GET
权限要求：管理员
描述：搜索系统所有日志

获取个人日志
路径：/api/log/self
方法：GET
权限要求：用户
描述：获取个人操作日志

搜索个人日志
路径：/api/log/self/search
方法：GET
权限要求：用户
描述：搜索个人操作日志

获取分组信息
路径：/api/group/
方法：GET
权限要求：管理员
描述：获取系统用户分组信息