LOGIN_API.md 2.2 KB

系统管理员登录 API 文档

本文档描述了系统管理员登录相关的接口规范。

1. 全局响应结构

所有接口的返回值均由 GlobalResponseWrapper 统一包装,遵循以下 JSON 结构:

{
  "code": 200,          // 状态码 (200: 成功, 其他: 失败)
  "message": "success", // 响应消息
  "success": true,      // 成功标识
  "data": { ... },      // 具体业务数据
  "timestamp": 1709628736123 // 响应时间戳
}

2. 获取图片验证码

  • URL: /v2/admin/login
  • Method: GET
  • 描述: 获取登录所需的图形验证码及唯一标识。

响应参数 (data 字段)

字段名 类型 说明
uuid string 验证码唯一标识 (登录时需带回)
img string Base64 格式的验证码图片

响应示例

{
  "code": 200,
  "message": "success",
  "success": true,
  "data": {
    "uuid": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
    "img": "data:image/gif;base64,R0lGODlhAQABAIAAAAAAAP///yH5BAEAAAAALAAAAAABAAEAAAIBRAA7"
  },
  "timestamp": 1709628736123
}

3. 系统管理员登录

  • URL: /v2/admin/login
  • Method: POST
  • Content-Type: application/json
  • 描述: 提交用户名、密码及验证码进行登录。

请求参数

字段名 类型 必填 说明
username string 是 用户名
password string 是 密码 (建议前端加密传输,当前后端实现为明文比对)
captcha string 是 验证码字符 (不区分大小写)
uuid string 是 获取验证码接口返回的 uuid
rememberMe boolean 否 是否记住我 (默认 false)

请求示例

{
  "username": "admin",
  "password": "your_password",
  "captcha": "ABCD",
  "uuid": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "rememberMe": true
}

响应参数 (data 字段)

字段名 类型 说明
token string 登录凭证 (后续请求需携带)

响应示例

{
  "code": 200,
  "message": "success",
  "success": true,
  "data": {
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9..."
  },
  "timestamp": 1709628738888
}