update readme

This commit is contained in:
MarSeventh
2025-05-13 20:11:16 +08:00
parent d6ac33e938
commit 6a3edbea59

View File

@@ -838,7 +838,7 @@ Web端在登录页面输入你的**认证码**即可登录使用API端需要
| ------------ | ------------------------------------------------------------ |
| **接口功能** | 上传图片或视频 |
| **请求方法** | POST |
| **请求参数** | **Query参数**<br />`authCode`: string类型即为你设置的认证码<br />`serverCompress`: boolean类型表示是否开启服务端压缩仅针对图片文件、Telegram上传渠道生效默认为`true`<br />`uploadChannel`: string类型取值为`telegram``cfr2`分别代表telegram bot渠道Cloudflare R2渠道默认为`telegram` 渠道<br />`autoRetry`: boolean类型表示是否开启上传失败自动切换渠道重试默认开启<br />`uploadNameType`: string类型表示文件命名方式可选值为`[default, index, origin, short]`,分别代表默认`前缀_原名`命名、`仅前缀`命名、`仅原名`命名和`短链接`命名法,默认为`default`<br />`returnFormat`:string类型表示返回链接格式可选值为`[default, full]`,分别代表默认的`/file/id`格式、完整链接格式<br />`uploadFolder`:string类型指定上传目录用相对路径表示例如上传到img/test目录需填`img/test`<br />**Body参数(application/form-data)**<br />`file`: file类型你要上传的文件 |
| **请求参数** | **Query参数**<br />`authCode`: string类型即为你设置的认证码<br />`serverCompress`: boolean类型表示是否开启服务端压缩仅针对图片文件、Telegram上传渠道生效默认为`true`<br />`uploadChannel`: string类型可选取值为`telegram``cfr2`和`s3`,分别代表 telegram bot 渠道Cloudflare R2 渠道和 S3 渠道,默认为`telegram` 渠道<br />`autoRetry`: boolean类型表示是否开启上传失败自动切换渠道重试默认开启<br />`uploadNameType`: string类型表示文件命名方式可选值为`[default, index, origin, short]`,分别代表默认`前缀_原名`命名、`仅前缀`命名、`仅原名`命名和`短链接`命名法,默认为`default`<br />`returnFormat`:string类型表示返回链接格式可选值为`[default, full]`,分别代表默认的`/file/id`格式、完整链接格式<br />`uploadFolder`:string类型指定上传目录用相对路径表示例如上传到img/test目录需填`img/test`<br />**Body参数(application/form-data)**<br />`file`: file类型你要上传的文件 |
| **返回响应** | `data[0].src`为获得的图片链接(注意不包含域名,需要自己添加) |
> **请求示例**