SysFileInfoController 接口文档
概述
SysFileInfoController 提供文件信息管理接口,包括文件列表查询、导出、新增、修改、删除等功能。用于管理系统中所有文件的元数据信息。
接口列表
查询接口
| 接口名称 |
接口路径 |
请求方法 |
说明 |
| 查询文件列表 |
/file/info/list |
GET |
查询文件列表,支持分页和条件过滤 |
| 获取文件详细信息 |
/file/info/{fileId} |
GET |
根据文件 ID 获取文件详细信息 |
管理接口
| 接口名称 |
接口路径 |
请求方法 |
说明 |
| 新增文件 |
/file/info |
POST |
新增文件记录 |
| 修改文件 |
/file/info |
PUT |
修改文件信息 |
| 删除文件 |
/file/info/{fileIds} |
DELETE |
删除文件记录,支持批量删除 |
导出接口
| 接口名称 |
接口路径 |
请求方法 |
说明 |
| 导出文件列表 |
/file/info/export |
POST |
导出文件列表到 Excel |
数据模型
SysFileInfo
| 字段名 |
类型 |
描述 |
必填 |
| fileId |
Long |
文件主键 |
否(新增时自动生成) |
| fileName |
String |
原始文件名 |
是 |
| filePath |
String |
统一逻辑路径(/开头) |
是 |
| storageType |
String |
存储类型(local/minio/oss) |
是 |
| fileType |
String |
文件类型/后缀 |
否 |
| fileSize |
Long |
文件大小(字节) |
否 |
| md5 |
String |
文件MD5 |
否 |
| createBy |
String |
创建人 |
否(自动设置) |
| createTime |
String |
创建时间 |
否(自动设置) |
| updateBy |
String |
更新人 |
否(自动设置) |
| updateTime |
String |
更新时间 |
否(自动设置) |
| delFlag |
String |
删除标志(0代表存在 2代表删除) |
否(默认为0) |
权限说明
所有接口都需要认证,具体权限如下:
| 接口 |
权限 |
| 查询文件列表 |
system:file:list |
| 导出文件列表 |
system:file:export |
| 获取文件详细信息 |
system:file:query |
| 新增文件 |
system:file:add |
| 修改文件 |
system:file:edit |
| 删除文件 |
system:file:remove |
使用流程
文件信息查询流程
- 调用 查询文件列表 查询文件列表
- 使用 fileId 调用 获取文件详细信息 获取详细信息
文件信息管理流程
- 调用 新增文件 创建文件记录
- 调用 修改文件 更新文件信息
- 调用 删除文件 删除文件记录
文件导出流程
- 调用 导出文件列表 导出文件列表到 Excel
- 浏览器会自动下载 Excel 文件
注意事项
- 所有接口都需要认证(需要携带 Authorization 头)
- 文件路径必须以 / 开头
- 存储类型必须是有效的值:local、minio、oss
- 删除操作是逻辑删除,将 delFlag 设置为 2
- 只能查询和操作删除标志为 0 的文件(未删除的文件)
- 支持批量删除,多个 fileId 用逗号分隔
相关文档