{
  "module": "用户管理",
  "moduleKey": "user",
  "apiCount": 5,
  "apis": [
    {
      "title": "获取用户列表",
      "method": "GET",
      "path": "/api/users",
      "description": "分页获取系统用户列表，支持按姓名、手机号、状态筛选。支持通过 X-Site header 切换站点，切换后查询对应站点的数据库。",
      "requestParams": {
        "query": [
          {
            "name": "pageNum",
            "type": "number",
            "required": false,
            "description": "页码，默认1"
          },
          {
            "name": "pageSize",
            "type": "number",
            "required": false,
            "description": "每页数量，默认10"
          },
          {
            "name": "name",
            "type": "string",
            "required": false,
            "description": "用户姓名（模糊搜索）"
          },
          {
            "name": "phone",
            "type": "string",
            "required": false,
            "description": "手机号（模糊搜索）"
          },
          {
            "name": "status",
            "type": "number",
            "required": false,
            "description": "状态：1-正常，0-禁用"
          }
        ]
      },
      "responseExample": {
        "success": {
          "code": 200,
          "message": "获取成功",
          "data": {
            "list": [
              {
                "id": 1,
                "code": "USER001",
                "name": "张三",
                "title": "系统管理员",
                "phone": "13800138000",
                "email": "zhangsan@example.com",
                "phonePrefix": "+86",
                "status": 1,
                "createTime": "2024-01-01T00:00:00.000Z"
              }
            ],
            "total": 100,
            "pageNum": 1,
            "pageSize": 10
          }
        }
      }
    },
    {
      "title": "获取用户详情",
      "method": "GET",
      "path": "/api/users/{id}",
      "description": "根据用户ID获取用户详细信息",
      "requestParams": {
        "path": [
          {
            "name": "id",
            "type": "string",
            "required": true,
            "description": "系统用户ID"
          }
        ]
      },
      "responseExample": {
        "success": {
          "code": "0000",
          "message": "获取成功",
          "data": {
            "id": 1,
            "code": "USER0001",
            "name": "系统管理员",
            "phone": "13800000000",
            "status": 1,
            "roles": [
              "ROLE0001"
            ],
            "createTime": "2025-01-01T10:00:00.000Z"
          }
        },
        "failure": {
          "code": "4040",
          "message": "系统用户不存在",
          "data": null
        }
      }
    },
    {
      "title": "创建用户",
      "method": "POST",
      "path": "/api/users",
      "description": "创建新的系统用户",
      "requestParams": {
        "body": {
          "name": "string｜必填，用户姓名",
          "phone": "string｜必填，手机号，唯一",
          "password": "string｜必填，登录密码",
          "roles": "array｜可选，绑定角色ID数组",
          "status": "number｜可选，状态：1-启用，0-禁用"
        }
      },
      "responseExample": {
        "success": {
          "code": "0000",
          "message": "创建系统用户成功",
          "data": {
            "id": 1,
            "code": "USER0001",
            "name": "系统管理员",
            "phone": "13800000000",
            "status": 1,
            "roles": [
              "ROLE0001"
            ],
            "createTime": "2025-01-01T10:00:00.000Z"
          }
        },
        "failure": {
          "code": "4000",
          "message": "创建系统用户失败",
          "data": null
        }
      }
    },
    {
      "title": "更新用户",
      "method": "PUT",
      "path": "/api/users/{id}",
      "description": "更新指定用户的信息",
      "requestParams": {
        "body": {
          "name": "string｜必填，用户姓名",
          "phone": "string｜必填，手机号，唯一",
          "password": "string｜必填，登录密码",
          "roles": "array｜可选，绑定角色ID数组",
          "status": "number｜可选，状态：1-启用，0-禁用"
        },
        "path": [
          {
            "name": "id",
            "type": "string",
            "required": true,
            "description": "系统用户ID"
          }
        ]
      },
      "responseExample": {
        "success": {
          "code": "0000",
          "message": "更新系统用户成功",
          "data": {
            "id": 1,
            "code": "USER0001",
            "name": "系统管理员",
            "phone": "13800000000",
            "status": 1,
            "roles": [
              "ROLE0001"
            ],
            "createTime": "2025-01-01T10:00:00.000Z"
          }
        },
        "failure": {
          "code": "4000",
          "message": "更新系统用户失败",
          "data": null
        }
      }
    },
    {
      "title": "删除用户",
      "method": "DELETE",
      "path": "/api/users/{id}",
      "description": "删除指定的用户",
      "requestParams": {
        "path": [
          {
            "name": "id",
            "type": "string",
            "required": true,
            "description": "系统用户ID"
          }
        ]
      },
      "responseExample": {
        "success": {
          "code": "0000",
          "message": "删除系统用户成功",
          "data": {
            "result": true
          }
        },
        "failure": {
          "code": "4000",
          "message": "删除系统用户失败",
          "data": null
        }
      }
    }
  ]
}