Yaxin
/
5G-Loading-Bay-Web
27
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Compare commits

base: Yaxin:212f5b9e8173610a0efc24372b578edbf8f0b77b
Branches Tags
Yaxin:main
..
compare: Yaxin:17404fcb367b1b98594307d572195854f1a8a60c
Branches Tags
Yaxin:main

No commits in common. '212f5b9e8173610a0efc24372b578edbf8f0b77b' and '17404fcb367b1b98594307d572195854f1a8a60c' have entirely different histories.
212f5b9e81 ... 17404fcb36

2 changed files with 179 additions and 296 deletions
Show Stats

16
api.md
Unescape Escape View File

@ -23,14 +23,11 @@
- **响应示例**： - **响应示例**：
```json ```json
{ {
"code": 200, "code": 200,
"success": true, "message": "登录成功",
"data": { "data": {
"refresh": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoicmVmcmVzaCIsImV4cCI6MTc0MzA2ODU4NiwiaWF0IjoxNzQxNzcyNTg2LCJqdGkiOiI2MjNhNmUxM2Q3YjM0NmE4YTMzMGQ3ZGY5MTQ2YTliMCIsInVzZXJfaWQiOjF9.nhUnJuMDsQbKG96ma08bH17tWj-4PbQNUYx4vRzpbIQ", "token": "xxx-xxx-xxx" // 登录成功返回的 token
"access": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNzQyMzc3Mzg2LCJpYXQiOjE3NDE3NzI1ODYsImp0aSI6ImMzMmU0ZWQ5ZWU5MTQ3Nzc5MmFkNjQ1ZmM3NmZlYmE4IiwidXNlcl9pZCI6MX0.2IFz-zWaQF7HeL-SrjNR4o1A-9BebPx3KG7_OU1Y4yg", }
"status": "ok"
},
"errorMessage": ""
} }
``` ```
@ -46,9 +43,6 @@
```json ```json
{ {
"code": 200, "code": 200,
"success": true,
"data": {},
"errorMessage": ""
} }
``` ```

459
dashboard.md
Unescape Escape View File

@ -9,84 +9,65 @@
# 仪表盘模块（Dashboard）接口文档 # 仪表盘模块（Dashboard）接口文档
## 一、设备状态分页列表接口 ## 一、设备状态分页列表接口
### 1.1 接口基本信息 ### 1.1 接口基本信息
- **接口地址**：/api/v1/device/device/ - **接口地址**：/api/dashboard/device-status/list
- **请求方式**：GET - **请求方式**：GET
- **功能描述**：获取设备状态分页列表，支持条件查询 - **功能描述**：获取设备状态分页列表，支持条件查询
### 1.2 请求参数 ### 1.2 请求参数
| 参数名 | 类型 | 是否必填 | 说明 | 示例值 | | 参数名 | 类型 | 是否必填 | 说明 | 示例值 |
|---------------|--------|----------|--------------------------|----------------| |--------------|--------|----------|--------------------------|----------------|
| device_name | string | 否 | 设备名称（模糊查询） | "设备A" | | device_name | string | 否 | 设备名称（模糊查询） | "设备A" |
| device_number | string | 否 | 设备ID（精确查询） | "DEV-001" | | device_id | string | 否 | 设备ID（精确查询） | "DEV-001" |
| current | int | 是 | 分页页码 | 1 | | page | int | 是 | 分页页码 | 1 |
| pageSize | int | 是 | 每页数量 | 10 | | page_size | int | 是 | 每页数量 | 10 |
### 1.3 响应参数 ### 1.3 响应参数
| 参数名 | 类型 | 说明 | | 参数名 | 类型 | 说明 |
|---------------------------|----------|----------------------| |--------------|----------|--------------------------|
| code | int | 响应码（200为成功） | | code | int | 响应码（200为成功） |
| errorMessage | string | 异常信息 | | message | string | 响应信息 |
| data | object | 数据体 | | data | object | 数据体 |
| ├─ total | int | 总记录数 | | ├─ total | int | 总记录数 |
| ├─ data | array | 设备状态列表 | | ├─ list | array | 设备状态列表 |
| └─ ├─ device_name | string | 设备名称 | | └─ ├─ device_name | string | 设备名称 |
| └─ ├─ device_id | string | 设备ID | | └─ ├─ device_id | string | 设备ID |
| └─ ├─ device_location | string | 设备位置 | | └─ ├─ device_location | string | 设备位置 |
| └─ ├─ device_status | int | 设备状态（0=在线，1=离线，2=故障） | | └─ ├─ device_status | int | 设备状态（0=在线，1=离线，2=故障） |
| └─ └─ real_time_video_url | string | 实时视频路径 | | └─ └─ real_time_video_url | string | 实时视频路径 |
### 1.4 响应示例 ### 1.4 响应示例
```json ```json
{ {
"code": 200, "code": 200,
"success": true, "message": "获取成功",
"data": { "data": {
"total": 21, "total": 50,
"data": [ "list": [
{ {
"id": 21, "device_name": "工业机器人A",
"key": "21", "device_id": "DEV-001",
"device_number": "DEV-020", "device_location": "工厂1楼车间",
"device_name": "Say Device", "device_status": 0,
"device_position": "Floor 6, Room 101", "real_time_video_url": "https://xxx.com/real_time_001.mp4"
"device_status": "online",
"url": "https://www.johnson-malone.com/",
"created_at": "2025-03-12 14:52:21",
"updated_at": "2025-03-12 14:52:21"
},
{
"id": 20,
"key": "20",
"device_number": "DEV-019",
"device_name": "Reality Device",
"device_position": "Floor 10, Room 105",
"device_status": "offline",
"url": "https://www.lewis.com/",
"created_at": "2025-03-12 14:52:21",
"updated_at": "2025-03-12 14:52:21"
} }
], ]
"current": 1, }
"success": true,
"pageSize": 2
},
"errorMessage": ""
} }
``` ```
![alt text](image-1.png) ![alt text](image-1.png)
## 二、设备历史视频列表接口 ## 二、设备历史视频列表接口
### 2.1 接口基本信息 ### 2.1 接口基本信息
- **接口地址**：/api/v1/device/device_history/ - **接口地址**：/api/dashboard/device-history-video/list
- **请求方式**：GET - **请求方式**：GET
- **功能描述**：根据设备 ID 查询历史视频列表，支持日期时间过滤 - **功能描述**：根据设备 ID 查询历史视频列表，支持日期时间过滤
### 2.2 请求参数 ### 2.2 请求参数
| 参数名 | 类型 | 是否必填 | 说明 | 示例值 | | 参数名 | 类型 | 是否必填 | 说明 | 示例值 |
|------------|--------|----------|-----------------------------|--------------| |------------|--------|----------|-----------------------------|----------------|
| device_id | int | 是 | 设备 ID（关联设备详情） | 1 | | device_id | string | 是 | 设备 ID（关联设备详情） | "DEV-001" |
| start_time | string | 否 | 开始时间（格式：YYYY-MM-DD） | "2025-03-01" | | start_time | string | 否 | 开始时间（格式：YYYY-MM-DD） | "2025-03-01" |
| end_time | string | 否 | 结束时间（格式：YYYY-MM-DD） | "2025-03-31" | | end_time | string | 否 | 结束时间（格式：YYYY-MM-DD） | "2025-03-31" |
### 2.3 响应参数 ### 2.3 响应参数
| 参数名 | 类型 | 说明 | | 参数名 | 类型 | 说明 |
@ -101,35 +82,19 @@
### 2.4 响应示例 ### 2.4 响应示例
```json ```json
{ {
"code": 200, "code": 200,
"success": true, "message": "获取成功",
"data": { "data": {
"total": 10, "total": 15,
"data": [ "list": [
{ {
"id": 10, "video_url": "https://xxx.com/history_001.mp4",
"key": "10", "record_time": "2025-03-10 14:30:00"
"video_url": "ftp://192.168.10.38/1.mp4", }
"created_at": "2025-03-12 14:53:36", ]
"updated_at": "2025-03-12 14:53:36", }
"device": 1 }
},
{
"id": 9,
"key": "9",
"video_url": "ftp://192.168.10.38/1.mp4",
"created_at": "2025-03-12 14:53:36",
"updated_at": "2025-03-12 14:53:36",
"device": 1
}
],
"current": 1,
"success": true,
"pageSize": 2
},
"errorMessage": ""
}
``` ```
![alt text](image-2.png) ![alt text](image-2.png)
@ -137,24 +102,24 @@
## 一、撑杆监测分页列表接口 ## 一、撑杆监测分页列表接口
### 1.1 接口基本信息 ### 1.1 接口基本信息
- **接口地址**：/api/v1/record/record/ - **接口地址**：/api/pole-monitor/list
- **请求方式**：GET - **请求方式**：GET
- **功能描述**：获取撑杆监测分页列表，支持多条件筛选 - **功能描述**：获取撑杆监测分页列表，支持多条件筛选
### 1.2 请求参数 ### 1.2 请求参数
| 参数名 | 类型 | 是否必填 | 说明 | 示例值 | | 参数名 | 类型 | 是否必填 | 说明 | 示例值 |
|-----------------------|---------|----------|--------------------------|--------------| |--------------|---------|----------|-----------------------------|----------------|
| train_number | string | 否 | 车号（精确/模糊查询） | "JZ20250301" | | carNo | string | 否 | 车号（精确/模糊查询） | "JZ20250301" |
| train_model | string | 否 | 车型 | "货车" | | carType | string | 否 | 车型 | "货车" |
| train_carriage_number | string | 否 | 车厢号（精确查询） | "C001" | | carriageNo | string | 否 | 车厢号（精确查询） | "C001" |
| alarm_type | string | 否 | 告警类型（如：倾斜、断裂） | "倾斜" | | warnType | string | 否 | 告警类型（如：倾斜、断裂） | "倾斜" |
| fault_type | string | 否 | 故障类型（如：机械故障、电气故障） | "机械故障" | | faultType | string | 否 | 故障类型（如：机械故障、电气故障） | "机械故障" |
| level | int | 否 | 等级（1-3，数值越大越严重） | 2 | | level | int | 否 | 等级（1-3，数值越大越严重） | 2 |
| is_reviewed | boolean | 否 | 复核状态（true=已复核，false=未复核） | true | | review | boolean | 否 | 复核状态（true=已复核，false=未复核） | true |
| created_at | string | 否 | 监测日期（格式：YYYY-MM-DD） | "2025-03-10" | | date | string | 否 | 监测日期（格式：YYYY-MM-DD） | "2025-03-10" |
| current | int | 是 | 分页页码 | 1 | | page | int | 是 | 分页页码 | 1 |
| pageSize | int | 是 | 每页数量 | 10 | | page_size | int | 是 | 每页数量 | 10 |
| type | string | 是 | 固定为 pole | pole |
### 1.3 响应参数 ### 1.3 响应参数
| 参数名 | 类型 | 说明 | | 参数名 | 类型 | 说明 |
|------------------|----------|--------------------------| |------------------|----------|--------------------------|
@ -175,62 +140,39 @@
### 1.4 响应示例 ### 1.4 响应示例
```json ```json
{ {
"code": 200, "code": 200,
"success": true, "message": "获取成功",
"data": { "data": {
"total": 8, "total": 200,
"data": [ "list": [
{ {
"id": 19, "id": "PM001",
"key": "19", "carNo": "JZ20250301",
"train_number": "pS399", "carType": "货车",
"train_model": "home", "carriageNo": "C001",
"train_carriage_number": "C16", "warnType": "倾斜",
"alarm_type": "candidate", "faultType": "机械故障",
"fault_type": "several", "level": 2,
"level": 2, "review": false,
"is_reviewed": false, "date": "2025-03-10 09:00:00"
"created_at": "2025-03-12 14:46:55", }
"updated_at": "2025-03-12 14:46:55", ]
"type": "pole" }
}, }
{
"id": 16,
"key": "16",
"train_number": "vO272",
"train_model": "enough",
"train_carriage_number": "C49",
"alarm_type": "sing",
"fault_type": "scientist",
"level": 5,
"is_reviewed": true,
"created_at": "2025-03-12 14:46:54",
"updated_at": "2025-03-12 14:46:54",
"type": "pole"
}
],
"current": 1,
"success": true,
"pageSize": 2
},
"errorMessage": ""
}
``` ```
![alt text](image-3.png) ![alt text](image-3.png)
## 二、撑杆监测详情接口 ## 二、撑杆监测详情接口
### 2.1 接口基本信息 ### 2.1 接口基本信息
- **接口地址**：/api/v1/record/record_detail_list/ - **接口地址**：/api/pole-monitor/detail/{id}
- **请求方式**：GET - **请求方式**：GET
- **功能描述**：根据监测数据 ID 获取详细信息，包含图文列表及监测数据 - **功能描述**：根据监测数据 ID 获取详细信息，包含图文列表及监测数据
### 2.2 请求参数 ### 2.2 请求参数
| 参数名 | 类型 | 是否必填 | 说明 | 示例值 | | 参数名 | 类型 | 是否必填 | 说明 | 示例值 |
|--------|-----|----------|--------------------------|-----| |--------|--------|----------|--------------------------|--------------|
| id | int | 是 | 监测数据唯一标识（关联分页列表 ID） | 1 | | id | string | 是 | 监测数据唯一标识（关联分页列表 ID） | "PM001" |
| current | int | 是 | 分页页码 | 1 |
| pageSize | int | 是 | 每页数量 | 10 |
### 2.3 响应参数 ### 2.3 响应参数
| 参数名 | 类型 | 说明 | | 参数名 | 类型 | 说明 |
@ -258,47 +200,32 @@
### 2.4 响应示例 ### 2.4 响应示例
```json ```json
{ {
"code": 200, "code": 200,
"success": true, "message": "获取成功",
"data": { "data": {
"total": 10, "id": "PM001",
"data": [ "carNo": "JZ20250301",
{ "carType": "货车",
"id": 1, "carriageNo": "C001",
"key": "1", "warnType": "倾斜",
"name": "Christopher Lynch", "faultType": "机械故障",
"video_url": "ftp://192.168.10.38/1.mp4", "level": 2,
"image_url": "https://picsum.photos/963/650", "review": false,
"created_at": "2025-03-12 14:51:12", "date": "2025-03-10 09:00:00",
"updated_at": "2025-03-12 14:51:12", "image_list": [
"length": 6.08, {
"width": 0.81, "image_name": "pole_001.jpg",
"height": 0.67, "image_url": "https://xxx.com/pole_001.jpg",
"weight": 14.14, "capture_time": "2025-03-10 09:01:30",
"record": 1 "length": 5.2,
}, "width": 0.3,
{ "height": 0.3,
"id": 2, "weight": 120.5
"key": "2", }
"name": "Jon Williams", ]
"video_url": "ftp://192.168.10.38/1.mp4", }
"image_url": "https://placekitten.com/603/345", }
"created_at": "2025-03-12 14:51:12",
"updated_at": "2025-03-12 14:51:12",
"length": 6.57,
"width": 1.63,
"height": 2.04,
"weight": 26.9,
"record": 1
}
],
"current": 1,
"success": true,
"pageSize": 2
},
"errorMessage": ""
}
``` ```
![alt text](image-4.png) ![alt text](image-4.png)
@ -310,19 +237,18 @@
- **功能描述**：获取外观监测分页列表，支持多条件筛选 - **功能描述**：获取外观监测分页列表，支持多条件筛选
### 1.2 请求参数 ### 1.2 请求参数
| 参数名 | 类型 | 是否必填 | 说明 | 示例值 | | 参数名 | 类型 | 是否必填 | 说明 | 示例值 |
|-----------------------|---------|----------|--------------------------|--------------| |--------------|---------|----------|-----------------------------|----------------|
| train_number | string | 否 | 车号（精确/模糊查询） | "JZ20250301" | | carNo | string | 否 | 车号（精确/模糊查询） | "JZ20250301" |
| train_model | string | 否 | 车型 | "货车" | | carType | string | 否 | 车型 | "货车" |
| train_carriage_number | string | 否 | 车厢号（精确查询） | "C001" | | carriageNo | string | 否 | 车厢号（精确查询） | "C001" |
| alarm_type | string | 否 | 告警类型（如：倾斜、断裂） | "倾斜" | | warnType | string | 否 | 告警类型（如：倾斜、断裂） | "倾斜" |
| fault_type | string | 否 | 故障类型（如：机械故障、电气故障） | "机械故障" | | faultType | string | 否 | 故障类型（如：机械故障、电气故障） | "机械故障" |
| level | int | 否 | 等级（1-3，数值越大越严重） | 2 | | level | int | 否 | 等级（1-3，数值越大越严重） | 2 |
| is_reviewed | boolean | 否 | 复核状态（true=已复核，false=未复核） | true | | review | boolean | 否 | 复核状态（true=已复核，false=未复核） | true |
| created_at | string | 否 | 监测日期（格式：YYYY-MM-DD） | "2025-03-10" | | date | string | 否 | 监测日期（格式：YYYY-MM-DD） | "2025-03-10" |
| current | int | 是 | 分页页码 | 1 | | page | int | 是 | 分页页码 | 1 |
| pageSize | int | 是 | 每页数量 | 10 | | page_size | int | 是 | 每页数量 | 10 |
| type | string | 是 | 固定为 appearance | appearance |
### 1.3 响应参数 ### 1.3 响应参数
| 参数名 | 类型 | 说明 | | 参数名 | 类型 | 说明 |
@ -344,47 +270,26 @@
### 1.4 响应示例 ### 1.4 响应示例
```json ```json
{ {
"code": 200, "code": 200,
"success": true, "message": "获取成功",
"data": { "data": {
"total": 5, "total": 200,
"data": [ "list": [
{ {
"id": 17, "id": "PM001",
"key": "17", "carNo": "JZ20250301",
"train_number": "zE074", "carType": "货车",
"train_model": "create", "carriageNo": "C001",
"train_carriage_number": "C28", "warnType": "倾斜",
"alarm_type": "decision", "faultType": "机械故障",
"fault_type": "material", "level": 2,
"level": 4, "review": false,
"is_reviewed": false, "date": "2025-03-10 09:00:00"
"created_at": "2025-03-12 14:46:55", }
"updated_at": "2025-03-12 14:46:55", ]
"type": "appearance" }
}, }
{
"id": 14,
"key": "14",
"train_number": "Bp417",
"train_model": "ground",
"train_carriage_number": "C43",
"alarm_type": "market",
"fault_type": "rise",
"level": 2,
"is_reviewed": true,
"created_at": "2025-03-12 14:46:54",
"updated_at": "2025-03-12 14:46:54",
"type": "appearance"
}
],
"current": 1,
"success": true,
"pageSize": 2
},
"errorMessage": ""
}
``` ```
![alt text](image-5.png) ![alt text](image-5.png)
@ -397,11 +302,9 @@
- **功能描述**：根据监测数据 ID 获取详细信息，包含视频列表及监测数据 - **功能描述**：根据监测数据 ID 获取详细信息，包含视频列表及监测数据
### 1.2 请求参数 ### 1.2 请求参数
| 参数名 | 类型 | 是否必填 | 说明 | 示例值 | | 参数名 | 类型 | 是否必填 | 说明 | 示例值 |
|--------|-----|----------|--------------------------|-----| |--------|--------|----------|--------------------------|--------------|
| id | int | 是 | 监测数据唯一标识（关联列表 ID） | 1 | | id | string | 是 | 监测数据唯一标识（关联列表 ID） | "AM001" |
| current | int | 是 | 分页页码 | 1 |
| pageSize | int | 是 | 每页数量 | 10 |
### 1.3 响应参数 ### 1.3 响应参数
| 参数名 | 类型 | 说明 | | 参数名 | 类型 | 说明 |
@ -430,46 +333,32 @@
### 1.4 响应示例 ### 1.4 响应示例
```json ```json
{ {
"code": 200, "code": 200,
"success": true, "message": "获取成功",
"data": { "data": {
"total": 10, "id": "AM001",
"data": [ "carNo": "JZ20250302",
{ "carType": "客车",
"id": 1, "carriageNo": "C002",
"key": "1", "warnType": "变形",
"name": "Christopher Lynch", "faultType": "结构损伤",
"video_url": "ftp://192.168.10.38/1.mp4", "level": 3,
"image_url": "https://picsum.photos/963/650", "review": true,
"created_at": "2025-03-12 14:51:12", "date": "2025-03-10 10:00:00",
"updated_at": "2025-03-12 14:51:12", "video_list": [
"length": 6.08, {
"width": 0.81, "video_name": "appearance_001.mp4",
"height": 0.67, "video_url": "https://xxx.com/appearance_001.mp4",
"weight": 14.14, "capture_time": "2025-03-10 10:02:00",
"record": 1 "length": 6.5,
}, "width": 2.8,
{ "height": 3.2,
"id": 2, "volume": 58.24,
"key": "2", "weight": 8500.0
"name": "Jon Williams", }
"video_url": "ftp://192.168.10.38/1.mp4", ]
"image_url": "https://placekitten.com/603/345", }
"created_at": "2025-03-12 14:51:12", }
"updated_at": "2025-03-12 14:51:12",
"length": 6.57,
"width": 1.63,
"height": 2.04,
"weight": 26.9,
"record": 1
}
],
"current": 1,
"success": true,
"pageSize": 2
},
"errorMessage": ""
}
``` ```
![alt text](image-6.png) ![alt text](image-6.png)

Write Preview
Loading…
Cancel
Save