搜索结果

×

搜索结果将在这里显示。

🔥 用户相关操作

API 文档

目录

用户管理

1. 用户登录

接口说明：用户登录获取访问令牌

  • 请求地址：/auth/login
  • 请求方式：POST
  • 请求参数：
参数名 类型 必填 说明
username string 是 用户名
password string 是 密码

  • 请求示例：

    {
"username": "admin",
"password": "123456"
}

  • 响应示例：

    {
"code": "0000",
"msg": "success",
"data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
    "expires_at": 1700000000,
    "user": {
        "id": 1,
        "username": "admin",
        "email": "admin@example.com",
        "role_id": 1,
        "role_name": "管理员",
        "role_code": "ADMIN"
    }
}
}

2. 获取用户列表

接口说明：获取所有用户列表（需要管理员权限）

  • 请求地址：/users

  • 请求方式：GET

  • 请求头：

    • Authorization: Bearer {token}

  • 响应示例：

    {
"code": "0000",
"msg": "success",
"data": [
    {
        "id": 1,
        "username": "admin",
        "email": "admin@example.com",
        "role_id": 1,
        "role_name": "管理员",
        "role_code": "ADMIN"
    }
]
}

3. 获取单个用户

接口说明：获取指定ID的用户信息（需要管理员权限或查看自己的信息）

  • 请求地址：/users/{id}

  • 请求方式：GET

  • 请求头：

    • Authorization: Bearer {token}

  • 响应示例：

    {
"code": "0000",
"msg": "success",
"data": {
    "id": 1,
    "username": "admin",
    "email": "admin@example.com",
    "role_id": 1,
    "role_name": "管理员",
    "role_code": "ADMIN"
}
}

4. 创建用户

接口说明：创建新用户（需要管理员权限）

  • 请求地址：/users
  • 请求方式：POST
  • 请求头：
    • Authorization: Bearer {token}
  • 请求参数：
参数名 类型 必填 说明
username string 是 用户名
name string 是 姓名
email string 是 邮箱
password string 是 密码
role_id integer 是 角色ID

  • 请求示例：

    {
"username": "test",
"name": "测试用户",
"email": "test@example.com",
"password": "123456",
"role_id": 2
}

  • 响应示例：

    {
"code": "0000",
"msg": "success",
"data": {
    "id": 2,
    "username": "test",
    "name": "测试用户",
    "email": "test@example.com",
    "role_id": 2,
    "role_name": "普通用户",
    "role_code": "USER"
}
}

角色管理

1. 获取角色列表

接口说明：获取所有角色列表（需要管理员权限）

  • 请求地址：/roles

  • 请求方式：GET

  • 请求头：

    • Authorization: Bearer {token}

  • 响应示例：

    {
"code": "0000",
"msg": "success",
"data": [
    {
        "id": 1,
        "name": "管理员",
        "code": "ADMIN",
        "description": "系统管理员",
        "created_at": "2024-01-01 12:00:00",
        "updated_at": "2024-01-01 12:00:00"
    },
    {
        "id": 2,
        "name": "普通用户",
        "code": "USER",
        "description": "普通用户",
        "created_at": "2024-01-01 12:00:00",
        "updated_at": "2024-01-01 12:00:00"
    }
]
}

2. 获取单个角色

接口说明：获取指定ID的角色信息（需要管理员权限）

  • 请求地址：/roles/{id}

  • 请求方式：GET

  • 请求头：

    • Authorization: Bearer {token}

  • 响应示例：

    {
"code": "0000",
"msg": "success",
"data": {
    "id": 1,
    "name": "管理员",
    "code": "ADMIN",
    "description": "系统管理员",
    "created_at": "2024-01-01 12:00:00",
    "updated_at": "2024-01-01 12:00:00"
}
}

错误码说明

错误码 说明
0000 成功
9999 失败
400 请求参数错误
401 未授权
403 权限不足
404 资源不存在
500 服务器内部错误

注意事项

  1. 认证要求

    • 所有 API 都需要在请求头中携带 Authorization: Bearer {token} 进行身份验证
    • Token 可以通过登录接口获取

  2. 权限要求

    • 用户管理相关接口需要管理员权限（role_code 为 'ADMIN'）
    • 普通用户只能查看自己的信息

  3. 数据安全

    • 密码在传输和存储时都会进行加密处理
    • 敏感信息（如密码）不会在响应中返回

  4. 时间格式

    • 所有时间字段统一使用 YYYY-MM-DD HH:mm:ss 格式

  5. 错误处理

    • 所有错误都会返回统一的错误码和错误信息
    • 建议在客户端做好错误处理和提示