🎵 星屿音乐服务 API 文档

服务地址：http://music.kuiyuoo.com
支持QQ、网易云音乐、酷狗、酷我四个平台
协议：HTTP / JSON

1. 调用服务接口的方法

POST /api/call | GET /api/call

通用调用处理器，执行音乐服务定义的任意接口。

请求参数

参数名	类型	必填	说明
platform	string	是	插件标识（如 `QQ` or `QQ-New`）
method	string	是	方法名（如 `search`）
args	object	否	参数对象，直接传给插件方法
timeout	number	否	超时时间（毫秒），默认 8000

示例

POST 请求

curl -X POST http://localhost:3000/api/call \
  -H "Content-Type: application/json" \
  -d '{
    "platform": "QQ",
    "method": "search",
    "args": {
      "query": "晴天",
      "page": 1,
      "type": "music"
    }
  }'

GET 请求

curl "http://localhost:3000/api/call?platform=QQ&method=search&args=%7B%22query%22%3A%22%E6%99%B4%E5%A4%A9%22%2C%22page%22%3A1%2C%22type%22%3A%22music%22%7D"

响应示例

{
  "success": true,
  "data": { ... }
}

2. 获取插件完整信息

GET /api/plugin?platform=xxx

curl "http://localhost:3000/api/plugin?platform=QQ"

{
  "platform": "QQ",
  "methods": ["search(query, page, type)", "getMediaSource(mediaItem, quality)"],
  "info": {...}
}

3. 获取所有已加载插件的 platform 列表

GET /api/plugins

curl "http://localhost:3000/api/plugins"

{
  "platforms": ["QQ", "WY", "KW"]
}

4. 热重载插件

GET /api/reload

curl "http://localhost:3000/api/reload"

{ "success": true, "message": "插件已重载" }

错误码说明

HTTP 状态码	说明
200	请求成功
400	参数错误
404	插件未找到
500	服务端错误

文档版本 1.0 | 最后更新 2026-03-21