XuJiacheng
5239411ec7
- 新增 openspec-propose 技能，支持快速提案生成变更及相关文档。 - 新增接口汇总文档，整理后端接口及其用途。 - 新增页面功能说明文档，描述各页面的功能及路由。 - 新增项目总览文档，概述项目结构、技术栈及运行方式。 - 新增工具与非标准实现说明文档，记录项目中的特殊实现及约定。 - 创建 legacy-project-documentation 变更，整合现有文档并迁移至正式 OpenSpec 目录。 - 记录项目中的高风险历史实现特征，明确页面启用状态及接口调用关系。
5.6 KiB
5.6 KiB
接口汇总
基础地址
public/config.js 当前定义的基础地址如下：
| 标识 | 地址 | 典型用途 |
|---|---|---|
ApiList[0] |
http://blv-rd.tech:19088/api/ |
UDP 日志、房态、功率、用户信息、配置字典 |
ApiList[1] |
http://blv-rd.tech:19055/api/ |
酒店列表、主机列表、黑名单、房间统计 |
ApiList[2] |
http://www.boonlive-rcu.com:7000/api/ |
TFTP/RCU 特定操作 |
config.Api |
http://blv-rd.tech:19088/api/ |
fetch 文件上传等直接调用 |
按接口前缀整理
UDPPackage
主要由 ApiList[0] 承载。
| 接口 | 调用页面 | 作用 |
|---|---|---|
UDPPackage/GetUDPTotalAnalysis |
UDP 监控 | 查询 UDP 汇总统计 |
UDPPackage/ExportUDPTotalAnalysis |
UDP 监控 | 导出 UDP 汇总数据 |
UDPPackage/ConfigParameterSet |
UDP 监控 | 设置监控参数 |
UDPPackage/GetUDPPackageTimeAnalysis |
线程耗时记录 | 获取线程步骤耗时 |
UDPPackage/Get_IOTLog |
语音助手日志 | 获取语音日志 |
UDPPackage/Get_IOTLogCount |
语音助手日志 | 获取日志总数 |
UDPPackage/Get_BeforeTakeCardStatus |
房态日志 | 查询某时刻前置房态 |
UDPPackage/Get_RCUStatus |
房态日志 | 查询在线/离线房态 |
UDPPackage/Get_TakeCardStatus |
房态日志 | 查询取断电状态 |
LowerMachineLog
主要由 ApiList[1] 承载，少部分页面也通过默认 $http 调同名前缀。
| 接口 | 调用页面 | 作用 |
|---|---|---|
LowerMachineLog/GetHotelList |
UDP 监控、黑名单、TFTP 管理、语音日志、房态日志、功率记录 | 获取酒店列表 |
LowerMachineLog/GetHostList |
UDP 监控、黑名单、TFTP 管理、语音日志、房态日志 | 获取主机或房间列表 |
调用特征：
- 多数页面用
qs.stringify(getdate)作为请求体。 - 典型场景是根据酒店代码换取房间、主机或设备列表。
BlockIP
主要由 ApiList[1] 承载。
| 接口 | 调用页面 | 作用 |
|---|---|---|
BlockIP/BlockLWRemove |
黑名单管理 | 取消酒店过滤 |
BlockIP/BlockLWSet |
黑名单管理 | 设置酒店或主机过滤 |
BlockIP/GetBlockLWSetData |
黑名单管理 | 获取黑名单数据 |
BlockIP/GetConfigParameterList |
UDP 监控 | 获取监控配置参数 |
BlockIP/GetRoomCount |
UDP 监控、语音日志、房态日志、功率记录 | 获取酒店房间总数 |
values
由 ApiList[2] 承载。
| 接口 | 调用页面 | 作用 |
|---|---|---|
values/GetTFTPInfo |
TFTP 管理 | 获取当前 TFTP 设置 |
values/TFTPSet_Execute |
TFTP 管理 | 下发 TFTP 设置 |
iis
由 ApiList[2] 承载。
| 接口 | 调用页面 | 作用 |
|---|---|---|
iis/Recly |
UDP 监控 | 触发远程回收/重启类操作 |
Power
由 ApiList[0] 承载。
| 接口 | 调用页面 | 作用 |
|---|---|---|
Power/GetPowerAnalysis |
功率记录 | 查询功率分析数据 |
ConfigPY
由 ApiList[0] 承载。
| 接口 | 调用页面 | 作用 |
|---|---|---|
ConfigPY/GetConfigString |
字典管理 | 获取配置字典 |
ConfigPY/SaveOrAddConfigString |
字典管理 | 保存配置字典 |
ConfigPY/GetSingleValue |
个人设置 | 获取单项配置值 |
Users / Company
由 ApiList[0] 承载。
| 接口 | 调用页面 | 作用 |
|---|---|---|
Company/GetComInfo |
个人设置 | 获取公司信息 |
Users/GetUserInfo |
个人设置 | 获取用户详情 |
Users/EditUser |
个人设置 | 更新用户资料 |
FileUpload
直接通过 fetch(config.Api + 'FileUpload/UploadFile') 调用。
| 接口 | 调用位置 | 作用 |
|---|---|---|
FileUpload/UploadFile |
App.vue 注入的 ajaxfile |
上传头像或其他文件 |
参数风格说明
项目接口调用参数并不统一，主要有三种：
- 直接传对象，让 axios 拦截器自动
JSON.stringify。 - 调用方先手动
JSON.stringify，再传给 axios。 - 用
qs.stringify组装表单格式参数，并附带自定义 headers。
后续维护时，不要想当然把所有 POST 都改成传对象；必须先确认目标接口当前依赖的是哪一种风格。