mirror of https://github.com/project-mirai/mirai-api-http.git synced 2024-10-23 08:44:15 +08:00

Mirai HTTP API (console) plugin

Go to file

ryoii e9d5609b1c Release 2.10.0		2023-11-27 16:15:33 +08:00
.github	Release 2.9.1	2023-03-02 18:00:08 +08:00
.idea	Add copyright settings for idea	2023-10-08 13:07:16 +08:00
API-Tester	Update readme, changelog, docs, tester	2020-08-20 06:39:36 +08:00
buildSrc	Update dependencies version	2023-09-19 17:51:23 +08:00
docs	Add `ShortVideo` in MessageType.md	2023-11-27 16:08:30 +08:00
gradle/wrapper	Update dependencies	2022-08-08 18:27:07 +08:00
mirai-api-http	Release 2.10.0	2023-11-27 16:15:33 +08:00
mirai-api-http-spi	Abi breaking change for `StateCode` serialization	2023-10-09 11:04:05 +08:00
.gitignore	Serializer impl and test	2021-04-25 00:08:21 +08:00
build.gradle.kts	Update core to 2.16.0-RC	2023-10-12 11:34:49 +08:00
CHANGELOG.md	Release 2.10.0	2023-11-27 16:15:33 +08:00
gradle.properties	Release 2.10.0	2023-11-27 16:15:33 +08:00
gradlew	unfinished gradle 1111	2020-02-28 18:39:47 +08:00
gradlew.bat	unfinished gradle 1111	2020-02-28 18:39:47 +08:00
LICENSE	LICENSE	2020-02-28 17:54:04 +08:00
README.md	fix typo	2022-12-12 15:01:18 +08:00
settings.gradle.kts	Fix buildscript for publishing	2023-02-11 12:36:31 +00:00

README.md

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 支持自动更新插件，支持设置插件更新频道等功能
2.x 版本需要切换到 stable-v2 的 channel

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

启动 MCL 完成自动更新和启动

./mcl -u

开始使用

编辑config/net.mamoe.mirai-api-http/setting.yml配置文件 (没有则自行创建)
启动MCL ./mcl
如果手动安装则启动 mirai-console(不建议)
记录日志中出现的authKey

setting.yml模板

## 配置文件中的值，全为默认值

## 启用的 adapter, 内置有 http, ws, reverse-ws, webhook
adapters:
  - http
  - ws

## 是否开启认证流程, 若为 true 则建立连接时需要验证 verifyKey
## 建议公网连接时开启
enableVerify: true
verifyKey: 1234567890

## 开启一些调试信息
debug: false

## 是否开启单 session 模式, 若为 true，则自动创建 session 绑定 console 中登录的 bot
## 开启后，接口中任何 sessionKey 不需要传递参数
## 若 console 中有多个 bot 登录，则行为未定义
## 确保 console 中只有一个 bot 登录时启用
singleMode: false

## 历史消息的缓存大小
## 同时，也是 http adapter 的消息队列容量
cacheSize: 4096

## adapter 的单独配置，键名与 adapters 项配置相同
adapterSettings:
  ## 详情看 http adapter 使用说明 配置
  http:
    host: localhost
    port: 8080
    cors: ["*"]
    unreadQueueMaxSize: 100
  
  ## 详情看 websocket adapter 使用说明 配置
  ws:
    host: localhost
    port: 8080
    reservedSyncId: -1

Adapter

mirai-api-http 提供了多种接口调用方式, 并进行模块化称为 adapter

对于较常使用的调用方式, 内置了4种 adapter

http: 基于轮询的 http 接口
ws: websocket server 形式的接口
reverse-ws: websocket client 形式的接口
webhook: http 回调形式的接口

adapter 可以多个同时开启, 请按需启用

Adapter 一览

迁移至 2.x

从 1.x 迁移至 2.x 有不少变动，提供迁移文档参考

可能无法覆盖所有变更

调试API

(2.x 未更新)

更新日志

点我查看

文档

在线文档