5G-Loading-Bay-Web/api.md

系统接口文档

一、登录模块（Login）

1.1 用户登录接口

• 接口地址：/api/login

• 请求方式：POST

• 请求参数：

  参数名	类型	是否必填	说明
  username	string	是	用户账号
  password	string	是	登录密码

• 响应示例：

{
    "code": 200,
    "success": true,
    "data": {
        "refresh": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoicmVmcmVzaCIsImV4cCI6MTc0MzA2ODU4NiwiaWF0IjoxNzQxNzcyNTg2LCJqdGkiOiI2MjNhNmUxM2Q3YjM0NmE4YTMzMGQ3ZGY5MTQ2YTliMCIsInVzZXJfaWQiOjF9.nhUnJuMDsQbKG96ma08bH17tWj-4PbQNUYx4vRzpbIQ",
        "access": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNzQyMzc3Mzg2LCJpYXQiOjE3NDE3NzI1ODYsImp0aSI6ImMzMmU0ZWQ5ZWU5MTQ3Nzc5MmFkNjQ1ZmM3NmZlYmE4IiwidXNlcl9pZCI6MX0.2IFz-zWaQF7HeL-SrjNR4o1A-9BebPx3KG7_OU1Y4yg",
        "status": "ok"
    },
    "errorMessage": ""
}

1.2 用户登录接口

• 接口地址：/api/logout

• 请求方式：POST

• 请求参数：

  参数名	类型	是否必填	说明
  token	string	是	登录成功返回的 token

• 响应示例：

{
  "code": 200,
  "success": true,
  "data": {},
  "errorMessage": ""
}

检测总量汇总接口文档

1. 接口基本信息

• 接口名称：获取检测总量汇总数据
• 请求方法：GET
• 接口路径：/api/v1/system/get_record_stats/
• 功能描述：根据传入的时间类型（月/周），获取检测时间、车体检测数量、撑杆检测数量的汇总数据，用于展示柱状图。

2. 请求参数

参数名	类型	是否必填	描述	示例值
dateType	string	是	时间类型，取值month或week	month

3. 响应参数

参数名	类型	描述
code	number	状态码，200表示成功
message	string	提示信息，如成功或失败描述
data	object	响应数据主体
├─ dateArr	array	所有时间的汇总数组
├─ vehicleDetection	array	所有车辆检测数量汇总数组
├─ poleDetection	array	所有撑杆检测数量汇总数组

4. 响应示例

{
    "code": 200,
    "success": true,
    "data": {
        "dateArr": [
            1,
            2,
            3,
            4,
            5,
            6,
            7
        ],
        "pole": [
            0,
            8,
            0,
            0,
            0,
            0,
            0
        ],
        "appearance": [
            0,
            5,
            0,
            0,
            0,
            0,
            0
        ]
    },
    "errorMessage": ""
}

设备信息接口文档

1. 接口基本信息

• 接口名称：获取设备信息数据
• 请求方法：GET
• 接口路径：/api/v1/system/get_device_stats/
• 功能描述：获取设备总数，以及车体检测、撑杆检测、钩机检测设备的总量，同时包含各类设备的在线、离线、故障数量状态。

2. 请求参数

参数名	类型	是否必填	描述
无	无	无	无请求参数

3. 响应参数

参数分类	参数名	类型	描述
设备总数	deviceTotal	number	设备总数
车体检测设备	vehicleDetectionDevice	number	车体检测设备总量
车体检测状态	vehicleStatus	object	车体检测设备状态信息
├─ 在线数量	├─ onlineCount	number	车体检测设备在线数量
├─ 离线数量	├─ outlineCount	number	车体检测设备离线数量
├─ 故障数量	├─ errorCount	number	车体检测设备故障数量
撑杆检测设备	poleDetectionDevice	number	撑杆检测设备总量
撑杆检测状态	poleStatus	object	撑杆检测设备状态信息
├─ 在线数量	├─ onlineCount	number	撑杆检测设备在线数量
├─ 离线数量	├─ outlineCount	number	撑杆检测设备离线数量
├─ 故障数量	├─ errorCount	number	撑杆检测设备故障数量
钩机检测设备	machineDetectionDevice	number	钩机检测设备总量
钩机检测状态	machineStatus	object	钩机检测设备状态信息
├─ 在线数量	├─ onlineCount	number	钩机检测设备在线数量
├─ 离线数量	├─ outlineCount	number	钩机检测设备离线数量
├─ 故障数量	├─ errorCount	number	钩机检测设备故障数量

4. 响应示例

{
    "code": 200,
    "success": true,
    "data": {
        "deviceTotal": 36,
      "pole": { 
        "total": 12,
      "onlineCount": 8,  
      "outlineCount": 2,  
      "errorCount": 2  
    },"appearance": { 
        "total": 12,
      "onlineCount": 8,  
      "outlineCount": 2,  
      "errorCount": 2  
    },
      "excavator": { 
        "total": 12,
      "onlineCount": 8,  
      "outlineCount": 2,  
      "errorCount": 2  
    }
    },
    "errorMessage": ""
}

车体检测问题分布接口文档

1. 接口基本信息

• 接口名称：获取车体检测问题分布数据
• 请求方法：GET
• 接口路径：/api/v1/system/get_record_fault_stats/
• 功能描述：根据传入的时间类型，获取车体检测的问题类型及对应占比数据，用于展示饼图。

2. 请求参数

参数名	类型	是否必填	描述	示例值
dateType	string	是	时间类型（如week或month）	week
value	int	是	时间值	1
type	string	是	固定为appearance	appearance

3. 响应参数

参数名	类型	描述
code	number	状态码，200表示成功
message	string	提示信息（成功或失败描述）
data	array	车体检测问题分布数据数组
├─ name	string	问题类型（如搭扣未搭）
├─ value	number	问题占比数值（非百分制）

4. 响应示例

{
    "code": 200,
    "success": true,
    "data": [
        {
            "name": "rise",
            "value": 1
        },
        {
            "name": "material",
            "value": 1
        },
        {
            "name": "indeed",
            "value": 1
        },
        {
            "name": "economy",
            "value": 1
        },
        {
            "name": "daughter",
            "value": 1
        }
    ],
    "errorMessage": ""
}

撑杆检测问题分布接口文档

1. 接口基本信息

• 接口名称：获取撑杆检测问题分布数据
• 请求方法：GET
• 接口路径：/api/v1/system/get_record_fault_stats/
• 功能描述：根据传入的时间类型，获取撑杆检测的问题类型及对应占比数据，用于展示饼图。

2. 请求参数

参数名	类型	是否必填	描述	示例值
dateType	string	是	时间类型（如week或month）	week
value	int	是	时间值	1
type	string	是	固定为pole	pole

3. 响应参数

参数名	类型	描述
code	number	状态码，200表示成功
message	string	提示信息（成功或失败描述）
data	array	撑杆检测问题分布数据数组
├─ name	string	问题类型（如撑杆断折）
├─ value	number	问题占比数值（非百分制）

4. 响应示例

{
    "code": 200,
    "success": true,
    "data": [
        {
            "name": "rise",
            "value": 1
        },
        {
            "name": "material",
            "value": 1
        },
        {
            "name": "indeed",
            "value": 1
        },
        {
            "name": "economy",
            "value": 1
        },
        {
            "name": "daughter",
            "value": 1
        }
    ],
    "errorMessage": ""
}

实时监控画面接口文档

1. 接口基本信息

• 接口名称：获取实时监控画面
• 请求方法：GET
• 接口路径：/api/realTime/monitor
• 功能描述：获取实时监控画面数据，展示设备状态及问题（如搭扣未搭、撑杆断裂等）。

2. 请求参数

参数名	类型	是否必填	描述	示例值
deviceType	string	否	设备类型（如车体、撑杆）	vehicle

3. 响应参数

参数名	类型	描述
code	number	状态码，200表示成功
message	string	提示信息（如成功或失败）
data	array	监控画面数据数组
├─ imageUrl	string	监控画面图片/视频URL
├─ problemDesc	string	问题描述（如搭扣未搭）

4. 响应示例

{  
  "code": 200,  
  "message": "获取实时监控画面成功",  
  "data": [  
    {  
      "imageUrl": "https://example.com/train_vehicle_monitor.jpg",  
      "problemDesc": "搭扣未搭"  
    },  
    {  
      "imageUrl": "https://example.com/pole_monitor.jpg",  
      "problemDesc": "撑杆断裂"  
    }  
  ]  
}