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

Merge pull request #77 from aleck099/docs

Browse Source 
Disambiguation
This commit is contained in:
白池 2023-11-24 16:41:17 +08:00 committed by GitHub
commit 145a977ed0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 17 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
docs/api/shamrock.md
View File

@ -39,7 +39,14 @@ icon: feather-alt
}
```
## 下载文件到缓存目录
## 让Shamrock下载文件到缓存目录
用法二选一：
1.仅发送url，由Shamrock自己访问该url来下载文件
2.仅发送文件base64，Shamrock解码后直接转存为文件
url和base64至少一个不能为空
同时发送url和base64时，使用url
### API 端点
@ -55,16 +62,16 @@ icon: feather-alt
| thread_cnt | int32 | 否 | 下载的线程数量 | |
| headers | `string` or `array` | 否 | 请求头 | |
#### 字符串格式示例
```string
User-Agent=YOUR_UA[\r\n]Referer=https://www.baidu.com
```
#### JSON数组
#### headers为string时示例
```json
[
"headers": "User-Agent=YOUR_UA[\r\n]Referer=https://www.baidu.com"
```
#### headers为array时示例
```json
"headers": [
"User-Agent=YOUR_UA",
"Referer=https://www.baidu.com"
]
@ -164,4 +171,4 @@ User-Agent=YOUR_UA[\r\n]Referer=https://www.baidu.com
### 响应
无响应
无响应