Skip to content

API 概览

所有 API 响应格式统一为:

json
{
  "success": true,
  "data": { ... }
}

// 或错误时
{
  "success": false,
  "error": "错误信息"
}

基础地址

环境地址
本地开发http://127.0.0.1:8787
生产环境https://api.tangdoufangkuaiwu.top

认证

需要登录的接口在请求头中携带 JWT:

Authorization: Bearer <token>

JWT 通过登录或注册接口获取,有效期 7 天。

接口总览

方法路径鉴权说明
GET/健康检查
GET/api/init初始化数据库表
认证
POST/api/login用户登录
POST/api/validateRegisterCode验证注册码
POST/api/send-otp发送邮箱验证码
POST/api/check-otp校验 OTP 并注册
GET/api/meJWT当前用户信息
档案
GET/api/files档案列表
GET/api/files/:id档案详情(含下载数据)
POST/api/filesJWT上传档案
DELETE/api/files/:idJWT删除档案
工程
GET/api/projects工程列表
GET/api/projects/:id工程详情 + 成员
POST/api/projectsJWT创建工程
POST/api/projects/:id/joinJWT加入工程
POST/api/projects/:id/leaveJWT离开工程
DELETE/api/projects/:idJWT删除工程
监控
GET/api/monitor/minecraftMC 服务器状态
GET/api/monitor/systemJWT系统指标
GET/api/monitor/minecraft-localJWTMC RCON 状态
GET/api/monitor/health网站健康检查

错误码

HTTP 状态码含义
200成功
201创建成功
400请求参数错误
401未登录或 token 过期
403无权限
404资源不存在
429请求频率限制
500服务器内部错误

MIT Licensed