147 lines
3.3 KiB
Markdown
147 lines
3.3 KiB
Markdown
# 获取文件详细信息
|
||
|
||
## 接口信息
|
||
|
||
- **接口名称**: 获取文件详细信息
|
||
- **接口路径**: /file/info/{fileId}
|
||
- **请求方法**: GET
|
||
- **模块归属**: file
|
||
- **版本号**: v1.0.0
|
||
- **创建日期**: 2026-01-18
|
||
- **最后更新**: 2026-01-18
|
||
|
||
## 功能描述
|
||
|
||
根据文件 ID 获取文件的详细信息，包括文件名、文件路径、存储类型、文件类型、文件大小、MD5 等信息。
|
||
|
||
## 请求参数
|
||
|
||
### 路径参数
|
||
|
||
| 参数名 | 类型 | 必填 | 描述 | 示例 |
|
||
|--------|------|------|------|------|
|
||
| fileId | Long | 是 | 文件 ID | 1 |
|
||
|
||
## 响应数据
|
||
|
||
### 成功响应
|
||
|
||
**HTTP 状态码**: 200 OK
|
||
|
||
```json
|
||
{
|
||
"code": 200,
|
||
"msg": "操作成功",
|
||
"data": {
|
||
"fileId": 1,
|
||
"fileName": "test.jpg",
|
||
"filePath": "/upload/2026/01/18/1234567890_test.jpg",
|
||
"storageType": "minio",
|
||
"fileType": "jpg",
|
||
"fileSize": 102400,
|
||
"md5": "d41d8cd98f00b204e9800998ecf8427e",
|
||
"createBy": "admin",
|
||
"createTime": "2026-01-18T10:00:00",
|
||
"updateBy": "admin",
|
||
"updateTime": "2026-01-18T10:00:00",
|
||
"delFlag": "0"
|
||
}
|
||
}
|
||
```
|
||
|
||
| 字段名 | 类型 | 描述 | 示例 |
|
||
|--------|------|------|------|
|
||
| fileId | Long | 文件主键 | 1 |
|
||
| fileName | String | 原始文件名 | test.jpg |
|
||
| filePath | String | 统一逻辑路径 | /upload/2026/01/18/1234567890_test.jpg |
|
||
| storageType | String | 存储类型 | minio |
|
||
| fileType | String | 文件类型/后缀 | jpg |
|
||
| fileSize | Long | 文件大小（字节） | 102400 |
|
||
| md5 | String | 文件MD5 | d41d8cd98f00b204e9800998ecf8427e |
|
||
| createBy | String | 创建人 | admin |
|
||
| createTime | String | 创建时间 | 2026-01-18T10:00:00 |
|
||
| updateBy | String | 更新人 | admin |
|
||
| updateTime | String | 更新时间 | 2026-01-18T10:00:00 |
|
||
| delFlag | String | 删除标志 | 0 |
|
||
|
||
### 失败响应
|
||
|
||
**HTTP 状态码**: 401 Unauthorized
|
||
|
||
```json
|
||
{
|
||
"code": 401,
|
||
"msg": "没有权限访问",
|
||
"data": null
|
||
}
|
||
```
|
||
|
||
**HTTP 状态码**: 404 Not Found
|
||
|
||
```json
|
||
{
|
||
"code": 404,
|
||
"msg": "文件不存在",
|
||
"data": null
|
||
}
|
||
```
|
||
|
||
## 接口示例
|
||
|
||
### 请求示例
|
||
|
||
```bash
|
||
curl -X GET "http://localhost:8080/file/info/1" \
|
||
-H "Authorization: Bearer [token]"
|
||
```
|
||
|
||
### 响应示例
|
||
|
||
**成功**:
|
||
|
||
```json
|
||
{
|
||
"code": 200,
|
||
"msg": "操作成功",
|
||
"data": {
|
||
"fileId": 1,
|
||
"fileName": "test.jpg",
|
||
"filePath": "/upload/2026/01/18/1234567890_test.jpg",
|
||
"storageType": "minio",
|
||
"fileType": "jpg",
|
||
"fileSize": 102400,
|
||
"md5": "d41d8cd98f00b204e9800998ecf8427e",
|
||
"createBy": "admin",
|
||
"createTime": "2026-01-18T10:00:00",
|
||
"updateBy": "admin",
|
||
"updateTime": "2026-01-18T10:00:00",
|
||
"delFlag": "0"
|
||
}
|
||
}
|
||
```
|
||
|
||
## 错误处理
|
||
|
||
- 没有权限访问时返回 401 错误
|
||
- 文件不存在时返回 404 错误
|
||
- 参数错误时返回 400 错误
|
||
|
||
## 注意事项
|
||
|
||
- 需要权限：system:file:query
|
||
- fileId 必须是有效的文件 ID
|
||
- 只能查询删除标志为 0 的文件（未删除的文件）
|
||
|
||
## 相关接口
|
||
|
||
- [查询文件列表](./0001-list.md) - 查询文件列表
|
||
- [修改文件](./0005-edit.md) - 修改文件信息
|
||
- [删除文件](./0006-remove.md) - 删除文件
|
||
|
||
## 实现细节
|
||
|
||
- 使用 `ISysFileInfoService.selectSysFileInfoByFileId()` 查询文件信息
|
||
- 使用 `@PreAuthorize` 注解进行权限控制
|
||
- 继承 `BaseController` 获取基础功能
|
||
- 使用 `success()` 方法封装成功响应
|