fastapicall:快速调用api,简单配置,快速上手

fastapicall 插件配置教程

本插件允许你完全在 Koishi 控制台里通过表单方式快速添加 / 修改 / 删除 HTTP 指令,无需写一行代码。

1. 打开配置页

  1. 在 Koishi 控制台 → 插件市场 → 搜索并安装 fastapicall
  2. 在插件配置全局设置页点击 添加插件 添加 → 进入「配置」标签页

2. 总览:插件能配什么

外层字段含义默认值
endpoints 指令列表,每一项对应一条可执行指令 [](空列表)
timeout 每条指令的最大等待时间(毫秒) 5000

3. endpoints 每项字段详解

在「endpoints」里点击 添加项目,会出现如下字段:

字段类型是否必填说明 & 书写技巧
name string 最终生成的指令名。例:天气 → 用户输入 /天气 北京
url string 完整 URL,可用 {参数名} 占位。例:https://api.openweathermap.org/data/2.5/weather?q={city}&appid=xxx
method GET / POST - 下拉选择,默认为 GET
params 对象 { 参数名: 描述 } - 告诉插件需要哪些参数。例:{ "city": "城市名" } → 控制台表单会出现输入框,输入框中内容是变量名,后面内容是解释。params自动从用户发送消息中获取,以空格为界分割变量。
response string - 返回模板,支持 {字段}{嵌套.字段} 替换。留空则完整返回 JSON
headers 对象 { 键: 值 } - 自定义请求头,如 {"Authorization": "Bearer xxx"}
enabled boolean - 开关。关闭后该指令立即下线

4. response 模板写法示例

// 场景:请求百科返回 JSON 里含 abstract 和 url
"response": "简介:{abstract}\n原文:{url}"
//这里的换行符不能在输入框中直接输入,应点击右侧三个点→编辑json

// 场景:天气 JSON 里 data.temp 为温度
“response”: “当前温度 {data.temp}℃,湿度 {data.humidity}%”

5. 完整例子(ai随便写的,不一定可用)

[
  {
    "name": "上海百科",
    "url": "https://baike.baidu.com/subview/2539/2539.htm",
    "method": "GET",
    "params": {},
    "response": "📍{title}\\n简介:{abstract}\\n详情:{url}",
    "headers": {},
    "enabled": true
  },
  {
    "name": "笑话",
    "url": "https://official-joke-api.appspot.com/jokes/random",
    "method": "GET",
    "params": {},
    "response": "{setup}\\n{punchline}",
    "headers": {},
    "enabled": true
  }
]

6. 快速验证

  1. 保存配置 → 插件重载
  2. 在聊天窗口输入示例指令:上海百科笑话
  3. 若返回结果符合预期,即配置成功

所有修改都在 Koishi 控制台完成,无需重启机器人或手动编辑文件。

3 个赞