diff --git a/TP_PROJECT/TP后台接口文档.md b/TP_PROJECT/TP后台接口文档.md index 3f74218..80ebfc5 100644 --- a/TP_PROJECT/TP后台接口文档.md +++ b/TP_PROJECT/TP后台接口文档.md @@ -2,6 +2,8 @@ + + # TP后台接口文档 <details> <summary>查询单个</summary> @@ -12,17 +14,18 @@ - 请求参数: - ```json - {"record_time": "", "police_id": "",“event_type”: “”} - ``` - - + | 参数名 | 参数值 | 是否必填 | 参数类型 | 描述说明 | + | ----------- | ------------------- | -------- | -------- | ---------- | + | record_time | 2023-05-26T13:09:05 | 否 | datetime | 记录仪时间 | + | police_id | 00000001 | 否 | string | 警号 | + | event_type | 0 | 否 | int | 事件类型 | - 可选参数: - ```json - {“page”: “1”, “page_size”: “20”} - ``` + | 参数名 | 参数值 | 是否必填 | 参数类型 | 描述说明 | + | --------- | ------ | -------- | -------- | -------------------- | + | page | 1 | 否 | string | 页码 | + | page_size | 20 | 否 | string | 页面大小(每页条数) | - 结果示例:  @@ -34,11 +37,12 @@ - 请求链接:http://127.0.0.1:8002/api/ -- 可选参数: +- 可选参数: - ```json - {“page”: “1”, “page_size”: “20”} - ``` + | 参数名 | 参数值 | 是否必填 | 参数类型 | 描述说明 | + | --------- | ------ | -------- | -------- | -------------------- | + | page | 1 | 否 | string | 页码 | + | page_size | 20 | 否 | string | 页面大小(每页条数) | - 结果示例: </details> @@ -62,13 +66,31 @@ "relative_time": 4, "video_dir": "/d/test", "car_number": "苏a045689", - "ai_analysis": "cbwuipckwef", + "ai_analysis": "违规", "add_time": "2023-05-26T13:09:03", "update_time": "2023-05-26T13:09:01", "is_display": true } ``` + | 参数名 | 参数值 | 是否必填 | 参数类型 | 描述说明 | + | ------------- | ------------------- | -------- | -------- | ---------- | + | video_hash | vbhdrbvcw | 是 | string | 视频哈希 | + | record_time | 2023-05-26T13:09:05 | 是 | datetime | 记录仪时间 | + | police_id | 00000002 | 是 | string | 警号 | + | event_type | 1 | 是 | int | 事件类型 | + | is_violation | true | 是 | bool | 是否违规 | + | small_image | nvikefrooiwer | 是 | string | 缩略图 | + | relative_time | 4 | 是 | int | 视频时长 | + | video_dir | /d/test | 是 | string | 视频路径 | + | car_number | 苏a045689 | 是 | string | 车牌号 | + | ai_analysis | 违规 | 是 | string | 分析结果 | + | add_time | 2023-05-26T13:09:03 | 是 | datetime | 添加时间 | + | update_time | 2023-05-26T13:09:03 | 是 | datetime | 更新时间 | + | is_display | true | 是 | bool | 是否展示 | + + + - 结果示例: </details> <details> @@ -91,13 +113,29 @@ "relative_time": 4, "video_dir": "/d/test", "car_number": "苏a045689", - "ai_analysis": "cbwuipckwef", + "ai_analysis": "违规", "add_time": "2023-05-26T13:09:03", "update_time": "2023-05-26T13:09:01", "is_display": true } ``` + | 参数名 | 参数值 | 是否必填 | 参数类型 | 描述说明 | + | ------------- | ------------------- | -------- | -------- | ---------- | + | video_hash | vbhdrbvcw | 是 | string | 视频哈希 | + | record_time | 2023-05-26T13:09:05 | 是 | datetime | 记录仪时间 | + | police_id | 00000002 | 是 | string | 警号 | + | event_type | 1 | 是 | int | 事件类型 | + | is_violation | true | 是 | bool | 是否违规 | + | small_image | nvikefrooiwer | 是 | string | 缩略图 | + | relative_time | 4 | 是 | int | 视频时长 | + | video_dir | /d/test | 是 | string | 视频路径 | + | car_number | 苏a045689 | 是 | string | 车牌号 | + | ai_analysis | 违规 | 是 | string | 分析结果 | + | add_time | 2023-05-26T13:09:03 | 是 | datetime | 添加时间 | + | update_time | 2023-05-26T13:09:03 | 是 | datetime | 更新时间 | + | is_display | true | 是 | bool | 是否展示 | + - 备注:操作会修改uid为20的数据 - 结果示例: