Skip to content

认证接口

登录认证相关接口,包括登录、登出、刷新令牌等。

登录

用户登录获取访问令牌。

请求

POST /api/v1/auth/login

请求参数

json
{
  "username": "admin",
  "password": "123456",
  "captchaKey": "uuid",
  "captchaCode": "验证码"
}
参数类型必填说明
usernamestring用户名
passwordstring密码
captchaKeystring验证码缓存 key
captchaCodestring验证码

响应

json
{
  "code": "00000",
  "msg": "成功",
  "data": {
    "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
    "refreshToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
    "tokenType": "Bearer",
    "expiresIn": 7200
  }
}

登出

用户退出登录。

请求

POST /api/v1/auth/logout

请求头

Authorization: Bearer {accessToken}

响应

json
{
  "code": "00000",
  "msg": "成功"
}

刷新令牌

使用 refresh token 获取新的 access token。

请求

POST /api/v1/auth/refresh-token

请求参数

json
{
  "refreshToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
}

响应

json
{
  "code": "00000",
  "msg": "成功",
  "data": {
    "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
    "refreshToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
    "tokenType": "Bearer",
    "expiresIn": 7200
  }
}

获取验证码

获取图形验证码。

请求

GET /api/v1/auth/captcha

响应

json
{
  "code": "00000",
  "msg": "成功",
  "data": {
    "captchaKey": "uuid",
    "captchaImage": "data:image/png;base64,..."
  }
}

获取当前用户信息

获取当前登录用户的详细信息。

请求

GET /api/v1/users/me

请求头

Authorization: Bearer {accessToken}

响应

json
{
  "code": "00000",
  "msg": "成功",
  "data": {
    "userId": 1,
    "username": "admin",
    "nickname": "管理员",
    "avatar": "https://...",
    "deptId": 1,
    "roles": ["ADMIN"],
    "perms": ["sys:user:list", "sys:user:add"]
  }
}

基于 MIT 许可发布