/mirai-api-http

Mirai HTTP API (console) plugin

Primary LanguageKotlinGNU Affero General Public License v3.0AGPL-3.0

logo
title

Gitter Actions Status

Mirai 是一个在全平台下运行，提供 QQ Android 和 TIM PC 协议支持的高效率机器人框架

这个项目的名字来源于

京都动画作品《境界的彼方》的栗山未来(Kuriyama Mirai)

CRYPTON以初音未来为代表的创作与活动(Magical Mirai)

图标以及形象由画师DazeCake绘制

mirai-api-http

Mirai HTTP API (console) plugin

Mirai-API-http插件 提供HTTP API供所有语言使用mirai

开始使用

  1. 请首先运行Mirai-console相关客户端生成plugins文件夹
  2. 将mirai-api-http生成的jar包文件放入plugins文件夹中
  3. 编辑config/MiraiApiHttp/setting.yml配置文件 (没有则自行创建)
  4. 再次启动Mirai-console相关客户端
  5. 记录日志中出现的authKey

setting.yml模板

## 该配置为全局配置，对所有Session有效

# 可选，默认值为0.0.0.0
host: '0.0.0.0'

# 可选，默认值为8080
port: 8080          

# 可选，默认由插件第一次启动时随机生成，建议手动指定
authKey: 1234567890  

# 可选，缓存大小，默认4096.缓存过小会导致引用回复与撤回消息失败
cacheSize: 4096

# 可选，是否开启websocket，默认关闭，建议通过Session范围的配置设置
enableWebsocket: false

# 可选，配置CORS跨域，默认为*，即允许所有域名
cors: 
  - '*'

## 消息上报
report:
# 功能总开关
  enable: false
  # 群消息上报
  groupMessage:
    report: false
  # 好友消息上报
  friendMessage:
    report: false
  # 临时消息上报
  tempMessage:
    report: false
  # 事件上报
  eventMessage:
    report: false
  # 上报URL
  destinations: []
  # 上报时的额外Header
  extraHeaders: {}

## 心跳
heartbeat:
  # 功能总开关
  enable: false
  # 启动延迟
  delay: 1000
  # 心跳间隔
  period: 15000
  # 心跳上报URL
  destinations: []
  # 上报时的额外信息
  extraBody: {}
  # 上报时的额外头
  extraHeaders: {}

有关配置的详细信息请参考文档-其他.

调试API

调试API已完成,点我查看

更新日志

点我查看

文档