logo
0
0
WeChat Login

用户管理API

这是一个基于Flask的用户管理API,提供对user表的查询接口。

功能特性

  1. 获取用户列表(支持分页和筛选)
  2. 根据ID获取单个用户信息
  3. 搜索用户(按用户名或邮箱)

API接口说明

1. 获取用户列表

  • URL: /api/users
  • 方法: GET
  • 参数:
    • page: 页码,默认为1
    • per_page: 每页数量,默认为10,最大100
    • status: 用户状态筛选(ACTIVE, BANNED等)
    • role: 用户角色筛选(USER, ADMIN等)
  • 响应示例:
{
  "success": true,
  "data": {
    "users": [
      {
        "id": 1,
        "username": "example_user",
        "email": "user@example.com",
        "role": "USER",
        "status": "ACTIVE",
        "ban_reason": null,
        "ban_time": null,
        "ban_admin_id": null,
        "create_time": "2023-01-01T00:00:00",
        "update_time": "2023-01-01T00:00:00",
        "dom_num": 2
      }
    ],
    "pagination": {
      "page": 1,
      "per_page": 10,
      "total": 1,
      "pages": 1
    }
  }
}

2. 获取单个用户信息

  • URL: /api/users/<user_id>
  • 方法: GET
  • 参数:
    • user_id: 用户ID(路径参数)
  • 响应示例:
{
  "success": true,
  "data": {
    "user": {
      "id": 1,
      "username": "example_user",
      "email": "user@example.com",
      "role": "USER",
      "status": "ACTIVE",
      "ban_reason": null,
      "ban_time": null,
      "ban_admin_id": null,
      "create_time": "2023-01-01T00:00:00",
      "update_time": "2023-01-01T00:00:00",
      "dom_num": 2
    }
  }
}

3. 搜索用户

  • URL: /api/users/search
  • 方法: GET
  • 参数:
    • keyword: 搜索关键词(用户名或邮箱)
    • page: 页码,默认为1
    • per_page: 每页数量,默认为10,最大100
  • 响应示例:
{
  "success": true,
  "data": {
    "users": [
      {
        "id": 1,
        "username": "example_user",
        "email": "user@example.com",
        "role": "USER",
        "status": "ACTIVE",
        "ban_reason": null,
        "ban_time": null,
        "ban_admin_id": null,
        "create_time": "2023-01-01T00:00:00",
        "update_time": "2023-01-01T00:00:00",
        "dom_num": 2
      }
    ],
    "pagination": {
      "page": 1,
      "per_page": 10,
      "total": 1,
      "pages": 1
    }
  }
}

环境配置

  1. 安装依赖:
pip install -r requirements.txt
  1. 配置数据库连接:
    • 修改 .env 文件中的数据库连接信息

启动服务

python user_api.py

服务将运行在 http://localhost:5000

健康检查

访问 http://localhost:5000/health 检查服务状态