tcjlj/PicList
1
0
Fork 0
mirror of https://github.com/Kuingsmile/PicList.git synced 2025-03-13 08:28:13 -04:00
Code Issues Actions Packages Projects Releases Wiki Activity

✨ Feature(custom): update api doc

Browse Source
This commit is contained in:
Kuingsmile 2024-03-19 17:40:22 +08:00
parent 872a1a799e
commit 922f04f672
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
src/main/server/apiDoc.ts
View File

@ -13,7 +13,7 @@ PicList内置了一个小型的服务器，用于接收来自其他应用或其
发送请求时添加URL查询参数\`key\`即可，例如：\`http://xxx:36677/upload?key=xxx\`。 发送请求时添加URL查询参数\`key\`即可，例如：\`http://xxx:36677/upload?key=xxx\`。
### 表单上传 <Badge type="tip" text="2.6.3+" /> ### 表单上传
- 请求方法: \`POST\` - 请求方法: \`POST\`
- url: \`http://127.0.0.1:36677/upload\` （此处以默认配置为例） - url: \`http://127.0.0.1:36677/upload\` （此处以默认配置为例）
@ -29,11 +29,12 @@ PicList内置了一个小型的服务器，用于接收来自其他应用或其
即可上传。 即可上传。
::: tip Tip ### configName和picbed参数
PicList支持通过设置\`picbed\`和\`configName\`两个URL查询参数来指定上传图床和配置文件。例如： PicList支持通过设置\`picbed\`和\`configName\`两个URL查询参数来指定上传图床和配置文件。例如：
\`http://127.0.0.1:36677/upload?picbed=aws-s3&configName=piclist-test\` \`http://127.0.0.1:36677/upload?picbed=aws-s3&configName=piclist-test\`
该配置将会使用\`aws-s3\`图床，并且使用\`piclist-test\`配置文件。 该配置将会使用\`aws-s3\`图床，并且使用\`piclist-test\`配置文件。
:::
返回的数据： 返回的数据：