Skip to content

用户接口

用户管理相关接口,包括用户列表、新增、修改、删除等。

用户列表

分页查询用户列表。

请求

GET /api/v1/users

请求参数

参数类型必填说明
pageNumint页码,默认 1
pageSizeint每页条数,默认 10
usernamestring用户名,模糊查询
nicknamestring昵称,模糊查询
statusint状态:0-禁用 1-启用
deptIdint部门 ID

响应

json
{
  "code": "00000",
  "msg": "成功",
  "data": {
    "total": 100,
    "list": [
      {
        "id": 1,
        "username": "admin",
        "nickname": "管理员",
        "mobile": "13800138000",
        "email": "admin@example.com",
        "avatar": "https://...",
        "gender": 1,
        "status": 1,
        "deptId": 1,
        "deptName": "研发部",
        "roleNames": ["管理员"],
        "createTime": "2024-01-01 12:00:00"
      }
    ]
  }
}

用户详情

获取用户详情。

请求

GET /api/v1/users/{id}

路径参数

参数类型说明
idint用户 ID

响应

json
{
  "code": "00000",
  "msg": "成功",
  "data": {
    "id": 1,
    "username": "admin",
    "nickname": "管理员",
    "mobile": "13800138000",
    "email": "admin@example.com",
    "avatar": "https://...",
    "gender": 1,
    "status": 1,
    "deptId": 1,
    "roleIds": [1, 2]
  }
}

新增用户

创建新用户。

请求

POST /api/v1/users

请求参数

json
{
  "username": "zhangsan",
  "nickname": "张三",
  "password": "123456",
  "mobile": "13800138001",
  "email": "zhangsan@example.com",
  "gender": 1,
  "status": 1,
  "deptId": 2,
  "roleIds": [2, 3]
}

响应

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

修改用户

更新用户信息。

请求

PUT /api/v1/users/{id}

请求参数

json
{
  "nickname": "张三",
  "mobile": "13800138001",
  "email": "zhangsan@example.com",
  "gender": 1,
  "status": 1,
  "deptId": 2,
  "roleIds": [2, 3]
}

响应

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

删除用户

批量删除用户。

请求

DELETE /api/v1/users

请求参数

json
{
  "ids": [1, 2, 3]
}

响应

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

修改密码

修改当前用户密码。

请求

PUT /api/v1/users/password

请求参数

json
{
  "oldPassword": "123456",
  "newPassword": "654321"
}

响应

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

重置密码

重置指定用户密码。

请求

PUT /api/v1/users/{id}/password/reset

响应

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

用户下拉列表

获取用户下拉选项(用于表单选择器)。

请求

GET /api/v1/users/options

响应

json
{
  "code": "00000",
  "msg": "成功",
  "data": [
    { "value": 1, "label": "管理员" },
    { "value": 2, "label": "张三" }
  ]
}

基于 MIT 许可发布