API 文档

本系统提供 RESTful API 接口,所有响应均为 JSON 格式。
基地址:

通用响应格式

所有 API 返回统一结构,通过 code 字段判断业务结果。

{
  "code": 200,        // 200 成功 / 400 参数错误 / 401 未授权 / 403 禁止 / 404 未找到 / 500 服务器错误
  "message": "success",
  "data": {}          // 实际数据,可能为对象、数组或 null
}

登录态: 管理员相关接口需要先调用登录接口,登录态通过 Cookie/Session 自动保持。

🔐 管理员
POST /api/admin/login

管理员登录,默认账号 xialaosan001 / qq6241515.A

参数类型必填说明
usernamestring管理员账号
passwordstring管理员密码
POST /api/admin/logout

管理员退出登录(需登录态)

POST /api/admin/change_password

管理员修改自己的密码(需登录态)。需要原密码验证身份,新旧密码不能相同。 修改成功后会清除登录态,前端需引导重新登录。

参数类型必填说明
old_passwordstring当前密码
new_passwordstring新密码,不能与原密码相同
{
  "code": 200,
  "message": "密码修改成功, 请使用新密码重新登录",
  "data": { "username": "xialaosan001", "require_relogin": true }
}
code说明
400参数缺失 / 新旧密码相同
401未登录 / 原密码错误
👥 用户管理
POST /api/admin/users

创建新用户。有效期通过天数指定,后端根据当前时间自动计算到期时间。

参数类型必填说明
usernamestring用户账号(唯一)
passwordstring用户密码
daysint有效天数, 1 ~ 36500
{
  "code": 200,
  "message": "用户创建成功",
  "data": {
    "id": 1,
    "username": "test",
    "expire_time": "2025-06-15 14:30:00",
    "days": 30
  }
}
GET /api/admin/users

获取用户列表(分页 + 筛选)

参数类型必填说明
keywordstring账号模糊搜索
statusstringall / active(默认, 未过期) / expired
pageint页码,默认 1
page_sizeint每页数量,默认 10,最大 100
{
  "code": 200, "message": "success",
  "data": {
    "list": [
      {
        "id": 1, "username": "test",
        "expire_time": "2025-06-15 14:30:00",
        "created_at": "2025-05-16 14:30:00",
        "is_expired": false, "status": "未过期",
        "remaining_days": 30
      }
    ],
    "total": 100, "page": 1,
    "page_size": 10, "total_pages": 10
  }
}
POST /api/admin/users/<id>/renew

用户续期。规则:用户未过期时,在原 expire_time 上加天数;用户已过期时,从当前时间开始加天数。

参数类型必填说明
daysint续期天数, 1 ~ 36500
{
  "code": 200, "message": "续期成功 (+30 天)",
  "data": {
    "id": 1, "username": "test",
    "old_expire_time": "2025-06-15 14:30:00",
    "new_expire_time": "2025-07-15 14:30:00",
    "added_days": 30
  }
}
POST /api/admin/users/<id>/reset_password

管理员重置用户密码。无需提供原密码,直接强制设置新密码。

参数类型必填说明
passwordstring新密码,1-255 字符,不能与原密码相同
{
  "code": 200, "message": "密码重置成功",
  "data": { "id": 1, "username": "test" }
}
code说明
400密码为空 / 新密码与原密码相同
404用户不存在
PUT /api/admin/users/<id>

更新用户密码或直接设置到期时间(至少传一个字段)

参数类型必填说明
passwordstring新密码
expire_timestring新到期时间, 格式 YYYY-MM-DD HH:MM:SS
DELETE /api/admin/users/<id>

删除用户(不可恢复)

⚡ 用户接口
POST /api/user/login

用户登录接口。必须传 username、password、device_id 三项。 通过 device_id 可统计今日活跃用户和活跃设备。

参数类型必填说明
usernamestring账号
passwordstring密码
device_idstring设备唯一标识
{
  "code": 200, "message": "登录成功",
  "data": {
    "username": "test",
    "expire_time": "2025-06-15 14:30:00",
    "device_id": "DEVICE_001"
  }
}
在线测试
POST /api/user/change_password

用户自助修改密码。需要传入原密码进行身份验证。 已过期账号无法修改密码,请联系管理员重置。

参数类型必填说明
usernamestring账号
old_passwordstring原密码
new_passwordstring新密码,不能与原密码相同
{
  "code": 200, "message": "密码修改成功",
  "data": { "username": "test" }
}
code说明
400参数缺失 / 新旧密码相同
401账号或原密码错误
403账号已过期
📊 登录记录与统计
GET /api/admin/login_records

获取登录记录列表(分页 + 筛选)

参数类型必填说明
usernamestring按账号模糊搜索
device_idstring按设备 ID 模糊搜索
statusstringall / success / fail
pageint页码,默认 1
page_sizeint每页数量,默认 10,最大 100
GET /api/admin/stats

获取统计数据(用户总数 / 今日活跃用户 / 今日活跃设备 / 今日登录次数 / 已过期用户)

{
  "code": 200, "message": "success",
  "data": {
    "today_active_users": 12,
    "today_active_devices": 18,
    "today_login_count": 35,
    "total_users": 100,
    "expired_users": 5,
    "date": "2025-05-16"
  }
}