{
  "module": "客户端用户管理",
  "moduleKey": "clientUser",
  "apiCount": 7,
  "apis": [
    {
      "title": "获取客户端用户列表",
      "method": "GET",
      "path": "/api/client-users",
      "description": "分页获取客户端用户列表",
      "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": "状态过滤"
          }
        ]
      },
      "responseExample": {
        "success": {
          "code": "0000",
          "message": "获取成功",
          "data": {
            "list": [
              {
                "id": 1,
                "code": "CU0001",
                "name": "客户端管理员",
                "phone": "13900000000",
                "status": 1,
                "createTime": "2025-01-01T10:00:00.000Z"
              }
            ],
            "total": 100,
            "pageNum": 1,
            "pageSize": 10
          }
        }
      }
    },
    {
      "title": "获取客户端用户详情",
      "method": "GET",
      "path": "/api/client-users/{id}",
      "description": "根据客户端用户ID获取详细信息",
      "requestParams": {
        "path": [
          {
            "name": "id",
            "type": "string",
            "required": true,
            "description": "客户端用户ID"
          }
        ]
      },
      "responseExample": {
        "success": {
          "code": "0000",
          "message": "获取成功",
          "data": {
            "id": 1,
            "code": "CU0001",
            "name": "客户端管理员",
            "phone": "13900000000",
            "status": 1,
            "createTime": "2025-01-01T10:00:00.000Z"
          }
        },
        "failure": {
          "code": "4040",
          "message": "客户端用户不存在",
          "data": null
        }
      }
    },
    {
      "title": "创建客户端用户",
      "method": "POST",
      "path": "/api/client-users",
      "description": "创建新的客户端用户。系统自动生成初始密码，格式为 smk + 创建时刻时分秒（HHmmss，24 小时制），并在响应 data.initialPassword 中返回，请妥善告知用户。",
      "requestParams": {
        "body": {
          "name": "string｜必填，客户端用户姓名",
          "phone": "string｜必填，手机号，唯一",
          "email": "string｜可选，邮箱",
          "roles": "array｜可选，绑定角色ID数组",
          "status": "number｜可选，状态：1-启用，0-禁用",
          "individualism": "boolean｜可选，是否开通独立站点"
        }
      },
      "responseExample": {
        "success": {
          "code": "0000",
          "message": "创建客户端用户成功",
          "data": {
            "id": 1,
            "code": "CU0001",
            "name": "客户端管理员",
            "phone": "13900000000",
            "status": 1,
            "initialPassword": "smk100930",
            "createTime": "2025-01-01T10:09:30.000Z"
          }
        },
        "failure": {
          "code": "4000",
          "message": "创建客户端用户失败",
          "data": null
        }
      }
    },
    {
      "title": "更新客户端用户",
      "method": "PUT",
      "path": "/api/client-users/{id}",
      "description": "更新指定客户端用户的信息（不含密码，密码请使用重置密码接口）",
      "requestParams": {
        "body": {
          "name": "string｜可选，客户端用户姓名",
          "phone": "string｜可选，手机号，唯一",
          "email": "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": "CU0001",
            "name": "客户端管理员",
            "phone": "13900000000",
            "status": 1,
            "createTime": "2025-01-01T10:00:00.000Z"
          }
        },
        "failure": {
          "code": "4000",
          "message": "更新客户端用户失败",
          "data": null
        }
      }
    },
    {
      "title": "删除客户端用户",
      "method": "DELETE",
      "path": "/api/client-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
        }
      }
    },
    {
      "title": "切换客户端用户状态",
      "method": "PUT",
      "path": "/api/client-users/{id}/status",
      "description": "切换客户端用户的启用/禁用状态",
      "requestParams": {
        "body": {
          "status": "number｜必填，状态：1-有效，0-无效"
        },
        "path": [
          {
            "name": "id",
            "type": "string",
            "required": true,
            "description": "客户端用户ID"
          }
        ]
      },
      "responseExample": {
        "success": {
          "code": "0000",
          "message": "状态更新成功",
          "data": {
            "id": 1,
            "code": "CU0001",
            "name": "客户端管理员",
            "phone": "13900000000",
            "status": 1,
            "updateTime": "2025-01-01T10:00:00.000Z"
          }
        },
        "failure": {
          "code": "4040",
          "message": "客户端用户不存在",
          "data": null
        }
      }
    },
    {
      "title": "重置客户端用户密码",
      "method": "PUT",
      "path": "/api/client-users/{id}/reset-password",
      "description": "将指定客户端用户的密码重置为初始密码。初始密码格式为 smk + 重置时刻时分秒（HHmmss，24 小时制），响应 data.initialPassword 返回明文初始密码，请妥善告知用户。",
      "requestParams": {
        "path": [
          {
            "name": "id",
            "type": "string",
            "required": true,
            "description": "客户端用户ID"
          }
        ]
      },
      "responseExample": {
        "success": {
          "code": "0000",
          "message": "密码重置成功",
          "data": {
            "initialPassword": "smk143052"
          }
        },
        "failure": {
          "code": "4040",
          "message": "客户端用户不存在",
          "data": null
        }
      }
    }
  ]
}