shkong/OpenShamrock
1
0
Fork 0
mirror of https://github.com/whitechi73/OpenShamrock.git synced 2024-08-14 13:12:17 +08:00
Code Issues Packages Projects Releases Wiki Activity

支持为WebSocket的文件分段上传

Browse Source
This commit is contained in:
白池 2024-02-21 23:23:49 +08:00 committed by GitHub
parent 195feb01e4
commit 3810464dd3
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 32 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
docs/api/shamrock.md
View File

@ -21,12 +21,16 @@ icon: feather-alt
是否正常执行切换账号请求的响应。
## 上传文件到缓存目录
## 上传文件到缓存目录 （HTTP）
### API 端点
`/upload_file`
::: warning 注意
该接口仅仅为HTTP POST提供，WebSocket请使用另外一个。
:::
### 参数
以**file**格式上传文件，不要使用**binary**。
@ -39,6 +43,33 @@ icon: feather-alt
}
```
## 上传文件到缓存目录 （WebSocket）
### API 端点
`/upload_file_to_shamrock`
::: warning 注意
该接口仅仅为WebSocket提供。
:::
### 参数
| 名称 | 类型 | 作用 |
|------|-------|-------|
| md5 | string | 文件`hex格式`的md5值，32长度的字符串 |
| offset | uint64 | 文件分段上传偏移，默认值为0，从头上传 |
| chunk | string | 文件分段上传数据块（base64），无需开头`base64://` |
| file_size | uint64 | 总文件大小 |
### 响应数据
| 名称 | 类型 | 作用 |
|------|-------|-------|
| file_size | uint64 | 总文件大小 |
| finish | bool | 是否完成上传 |
| path | string | 该文件在安卓系统（shamrock环境）的路径 |
## 让Shamrock下载文件到缓存目录
用法二选一：