三、文件与接口
菜单入口:基础设施 → 文件管理 / API 日志 / API 接口 / 表单构建 / WebSocket。
本章介绍文件存储管理、API 日志排查、接口文档、表单设计器与 WebSocket 连接测试,覆盖文件链路与接口链路两类基础支撑能力。
3.1 文件配置
菜单入口:基础设施 → 文件管理 → 文件配置。
文件存储器(存储引擎)的配置管理,决定系统所有上传文件实际存到哪里。
页面操作:
- 查询:支持按配置名、存储器、创建时间筛选。
- 新增:填写配置名、存储器(数据库 DB / 本地磁盘 / 阿里云 OSS / 腾讯云 COS / 七牛云 / MinIO / S3 等)及对应存储器的连接参数(如 endpoint、bucket、accessKey 等)、备注。
- 编辑:修改存储器参数(如密钥轮换、bucket 变更)。
- 主配置:将该存储器设为默认主存储,之后所有未指定存储配置的上传都走它。
- 测试:用当前配置上传一个测试文件,验证连通性与权限是否正常。
- 删除 / 批量删除:移除存储配置,删除前确认已有文件的可访问性。
业务规则:
| 存储器 | 适用场景 |
|---|---|
| 数据库 DB | 演示/小规模,文件入库便于备份 |
| 本地磁盘 | 单机部署,注意磁盘空间与备份 |
| 阿里云 OSS / 腾讯云 COS / 七牛云 | 公有云生产环境 |
| MinIO / S3 | 私有化对象存储部署 |
- 全局必须有且仅有一个主配置,切换主配置后新上传走新存储,历史文件 URL 仍指向原存储。

数据变动:存储配置写入 infra 模块表;主配置切换与测试操作即时生效。
3.2 文件列表
菜单入口:基础设施 → 文件管理 → 文件列表。
系统统一文件台账:所有业务上传的文件(头像、附件、图片等)都记录在此。
页面操作:
- 查询:支持按文件路径、文件类型、创建时间筛选。
- 上传文件:手动选择本地文件上传,落到当前主配置的存储器。
- 复制链接:复制该文件的访问 URL,可直接粘贴给他人或在页面中引用。
- 删除 / 批量删除:删除文件记录,删除后原 URL 即失效。
业务规则:
- 列表展示文件名、文件路径、URL、文件大小、文件类型、文件内容预览、上传时间。
- 文件被业务记录(如审批附件)引用后,删除会使引用处无法再访问,删除前请确认。

数据变动:上传文件写入存储器并在 infra 模块登记记录;删除后原 URL 失效,引用它的业务记录会受影响。
3.3 API 访问日志
菜单入口:基础设施 → API 日志 → API 访问日志。
记录所有 REST API 调用明细(含耗时、结果码、操作名),是排查接口性能问题的第一入口。
页面操作:
- 查询:支持按用户编号、用户类型、应用名、请求时间、用户IP、执行时长、结果码筛选。
- 访问统计:以图表维度分析 API 流量与慢接口,定位高频/慢速接口。
- 导出:导出日志 Excel 留档。
- 详细(行内):查看单条请求的完整报文(请求参数、返回结果等)。
业务规则:
- 每次接口调用记录:用户编号/类型、应用名、用户 IP、请求方法与地址、请求时间、执行时长、操作结果、操作模块/操作名/操作类型。
- 按执行时长筛选可快速圈出慢接口;按结果码筛选可定位失败请求。

数据变动:日志由系统自动写入 infra 模块日志表,页面只读,无人工写入操作。
3.4 API 错误日志
菜单入口:基础设施 → API 日志 → API 错误日志。
只记录抛出异常的接口请求,用于集中排查程序错误,避免与正常访问日志混在一起。
页面操作:
- 查询:支持按用户编号、用户类型、应用名、异常时间、处理状态筛选。
- 导出:导出错误日志 Excel。
- 详细(行内):查看完整异常堆栈,定位出错代码行。
- 已处理(行内):标记该错误已修复处理,不再出现在待处理列表中。
- 已忽略(行内):标记无需处理(如已知问题、用户误操作),避免重复排查。
业务规则:
- 列表展示日志编号、用户编号/类型、应用名、请求方法与地址、异常发生时间、异常名、处理状态。
- 建议排障节奏:按异常时间倒序 → 点详细看堆栈 → 修复后点已处理闭环。

数据变动:错误日志自动写入;已处理 / 已忽略会更新该记录的处理状态。
3.5 API 接口 Swagger
菜单入口:基础设施 → API 接口。
内嵌 Swagger/Knife4j 在线接口文档,按模块分组展示系统全部 REST 接口、请求参数与返回结构,并支持在线调试。
功能说明:
- 开发/对接人员在此查看接口清单与字段说明,无需翻代码。
- 选中接口填入参数即可在线调用调试,验证接口可用性。
- 新增业务接口二次开发时,文档自动同步(依赖接口注解)。

数据变动:只读文档页,不产生业务数据。
3.6 表单构建
菜单入口:基础设施 → 表单构建。
拖拽式表单设计器,可视化搭建表单并产出 form-create JSON,供代码生成器、流程表单等场景复用。
页面操作:
- 左侧组件库拖入画布,右侧配置组件属性。
- 生成JSON:导出当前表单的 form-create JSON 配置,交给开发集成。
- 生成组件:导出表单的 Vue 组件代码。
- 预览:实时预览表单渲染效果。
- 清空:清空画布重新设计。
- 设置事件 / 编辑数据:配置组件事件与初始数据。
业务规则:
- 产出的 JSON 可用于流程表单(工作流审批单)等动态表单场景。
- 设计完成后务必先预览确认交互,再导出 JSON。

数据变动:设计内容仅在页面内,需通过生成JSON / 生成组件导出后才落到业务侧;页面本身不保存数据。
3.7 WebSocket
菜单入口:基础设施 → WebSocket。
WebSocket 长连接服务测试页,用于验证在线消息、通知推送所依赖的长连接通道是否正常。
功能说明:
- 页面显示当前连接状态(已连接/断开)。
- 可发送/接收测试消息,验证服务端推送是否到达。
- 站内信、实时通知收不到时,先来此页确认长连接本身是否正常。

数据变动:纯测试页,不产生业务数据。
