API 文档
Abudu edited this page Mar 23, 2022
·
17 revisions
- Qexo 的 API 后方通常加上斜杠，否则可能出现重定向，可能会影响使用
- 若没有特殊说明，以下 API 都需要鉴权，具体方法为在 POST 或 GET 中添加项 token="API密钥"
- Qexo 的 API 分为对公与程序内部调用两种，分别位于 pub 和 api 路径下，本文只说明对外 API，即可以通过 API 密钥进行校验
- 若没有特殊说明，本文提到的参数均需要 POST 请求
修改文件
| file | content |
|---|---|
| 文件路径 | 内容 |
{
"msg": "OK!",
"status": true
}修改文章
| file | content |
|---|---|
| 文章名 | 内容 |
{
"msg": "OK!",
"status": true
}保存文章草稿
| file | content |
|---|---|
| 文章名 | 内容 |
{
"msg": "OK!",
"status": true
}新建文件
| file | content |
|---|---|
| 文件路径 | 内容 |
{
"msg": "OK!",
"status": true
}删除文件
| file |
|---|
| 文件路径 |
{
"msg": "OK!",
"status": true
}删除文章
| file |
|---|
| 文章名 |
{
"msg": "OK!",
"status": true
}创建 Webhook 事件
| uri |
|---|
| https://xxx/api/webhook/ |
{
"msg": "设置成功！",
"status": true
}获取更新
{
"hasNew": false,
"newer": "1.5.5",
"newer_link": "https://github.com/am-abudu/Qexo/releases/tag/1.5.5",
"newer_time": "2022-02-16 23:27:23",
"newer_text": " 修复已知BUG; 添加友链清理功能 ",
"status": true
}获取文章列表
{
"status": true,
"posts": [
{
"name": "10",
"fullname": "10.md",
"path": "source/_posts/10.md",
"size": 592,
"status": true
},
{
"name": "11",
"fullname": "11.md",
"path": "source/_posts/11.md",
"size": 1118,
"status": true
}
]
}获取页面列表
{
"status": true,
"pages": [
{
"name": "404",
"path": "source/404/index.md",
"size": 5059
},
{
"name": "about",
"path": "source/about/index.md",
"size": 141
}
]
}获取配置列表
{
"status": true,
"configs": [
{
"name": "main.yml",
"path": ".github/workflows/main.yml",
"size": 1500
},
{
"name": "_config.butterfly.yml",
"path": "_config.butterfly.yml",
"size": 27990
}
]
}获取图片列表
{
"status": true,
"images": [
{
"name": "avatar-new-test3.png",
"size": 556194,
"url": "https://xxx",
"date": "2021-11-15 23:03:53",
"time": "1636988633.7590833"
},
{
"name": "image.png",
"size": 2080250,
"url": "https://xxx",
"date": "2022-02-15 16:05:39",
"time": "1644912339.5202296"
}
]
}自动修复程序
{
"msg": "尝试自动修复了 1 个字段，请在稍后检查和修改配置",
"status": true
}获取友链 无需鉴权
{
"data": [
{
"name": "iMaeGoo’s Blog",
"url": "https://www.imaegoo.com/",
"image": "https://www.imaegoo.com/images/avatar.jpg",
"description": "虹墨空间站",
"time": "1642516414.3821218"
},
{
"name": "Icarus",
"url": "https://ppoffice.github.io/hexo-theme-icarus/",
"image": "https://ppoffice.github.io/hexo-theme-icarus/img/avatar.png",
"description": "本站主题",
"time": "1642516682.7982264"
}
],
"status": true
}新增友链
| name | url | image | description | status |
|---|---|---|---|---|
| 名称 | 链接 | 图片URL | 描述 | 状态(隐藏/显示) |
{
"msg": "添加成功！",
"time": "1642516682.7982264",
"status": true
}编辑友链
| name | url | image | description | time | status |
|---|---|---|---|---|---|
| 名称 | 链接 | 图片URL | 描述 | 该友链的时间戳 | 状态(隐藏/显示) |
{
"msg": "修改成功！",
"status": true
}删除友链
| time |
|---|
| 该友链的时间戳 |
{
"msg": "删除成功！",
"status": true
}申请友链 无需鉴权但需要在设置中开启
| name | url | image | description |
|---|---|---|---|
| 名称 | 链接 | 图片URL | 描述 |
{
"msg": "申请成功！",
"time": "1642516682.7982264",
"status": true
}获取博主最后在线时间 已移除请使用/pub/status/
{
"msg": "1645543096",
"status": true
}获取自定义的字段 无需鉴权
| key |
|---|
| 字段名 |
{
"data": "xxxx",
"status": true
}获取消息
{
"data": [
{
"label": "title",
"content": "text",
"timestamp": "1647668134.7664979",
"time": "2022-03-19 13:35:34"
},
{
"label": "title1",
"content": "text1",
"timestamp": "1647668134.7664979",
"time": "2022-03-19 13:35:34"
},
],
"status": true
}
获取博客基本信息 无需鉴权
{
"data": {
"posts": "68",
"last": "1648050031"
},
"status": true
}错误返回在大多数情况相同
{
"msg": "Error Message",
"status": false
}