轻雪API文档

This commit is contained in:
远野千束 2024-04-20 17:02:57 +08:00
parent e0982f3a24
commit 1a930dc604
2 changed files with 45 additions and 1 deletions

View File

@ -31,7 +31,6 @@ log_level: "INFO" # 日志等级
log_icon: true # 是否显示日志等级图标(某些控制台字体不可用) log_icon: true # 是否显示日志等级图标(某些控制台字体不可用)
auto_report: true # 是否自动上报问题给轻雪服务器 auto_report: true # 是否自动上报问题给轻雪服务器
auto_update: true # 是否自动更新轻雪每天4点检查更新 auto_update: true # 是否自动更新轻雪每天4点检查更新
alconna_use_command_start: false # alconna是否使用默认指令前缀默认false
alconna_auto_completion: false # alconna是否自动补全指令默认false建议开启 alconna_auto_completion: false # alconna是否自动补全指令默认false建议开启
safe_mode: false # 安全模式,开启后将不会加载任何第三方插件 safe_mode: false # 安全模式,开启后将不会加载任何第三方插件

45
docs/usage/lyapi.md Normal file
View File

@ -0,0 +1,45 @@
---
title: 轻雪API
icon: code
order: 4
category: 使用指南
tag:
- 配置
- 部署
---
## **轻雪API**
轻雪API是轻雪运行中部分服务的支持由`go`语言编写,例如错误反馈,图床链接等,目前服务由轻雪服务器提供,用户无需额外部署
接口
- `url` `https://api.liteyuki.icu`
- `POST` `/register` 注册一个Bot
- 参数
- `name` `string` Bot名称
- `version` `string` Bot版本
- `version_id` `int` Bot版本ID
- `python` `string` Python版本
- `os` `string` 操作系统
- 返回
- `code` `int` 状态码
- `liteyuki_id` `string` 轻雪ID
- `POST` `/bug_report` 上报错误
- 参数
- `liteyuki_id` `string` 轻雪ID
- `content` `string` 错误信息
- `device_info` `string` 设备信息
- 返回
- `code` `int` 状态码
- `report_id` `string` 错误ID
- `POST` `/upload_image` 图床上传
- 参数
- `image` `file` 图片文件
- `liteyuki_id` `string` 轻雪ID,用于鉴权
- 返回
- `code` `int` 状态码
- `url` `string` 图床链接