暫無描述

ryoii fda8fa6f39 Serializer impl and test		4 年之前
.github	cfd34d27aa Fix workflow	5 年之前
API-Tester	34452e4b48 Update readme, changelog, docs, tester	5 年之前
docs	5850167c82 Fix misc	5 年之前
gradle	fda8fa6f39 Serializer impl and test	4 年之前
mirai-api-http	fda8fa6f39 Serializer impl and test	4 年之前
.gitignore	fda8fa6f39 Serializer impl and test	4 年之前
CHANGELOG.md	fda8fa6f39 Serializer impl and test	4 年之前
LICENSE	e0a5639554 LICENSE	6 年之前
README.md	c526c4b3c4 Update readme	5 年之前
build.gradle.kts	fda8fa6f39 Serializer impl and test	4 年之前
gradle.properties	fda8fa6f39 Serializer impl and test	4 年之前
gradlew	313f2c59f2 unfinished gradle 1111	6 年之前
gradlew.bat	313f2c59f2 unfinished gradle 1111	6 年之前
launcher.properties	fda8fa6f39 Serializer impl and test	4 年之前
settings.gradle.kts	fda8fa6f39 Serializer impl and test	4 年之前

---- [![Gitter](https://badges.gitter.im/mamoe/mirai.svg)](https://gitter.im/mamoe/mirai?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) [![Actions Status](https://github.com/mamoe/mirai-api-http/workflows/Gradle%20CI/badge.svg)](https://github.com/mamoe/mirai-api-http/actions) 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

安装`mirai-api-http`

使用 Mirai Console Loader 安装`mirai-api-http`

MCL 支持自动更新插件，支持设置插件更新频道等功能

.\mcl --update-package net.mamoe:mirai-api-http --channel stable --type plugin

手动安装`mirai-api-http`

运行 Mirai Console 生成plugins文件夹
从 Releases 下载jar并将其放入plugins文件夹中

开始使用

编辑config/MiraiApiHttp/setting.yml配置文件 (没有则自行创建)
启动 Mirai Console
记录日志中出现的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已完成,点我查看

更新日志

点我查看

README.md