Mirai HTTP API 插件安装与使用教程

Mirai HTTP API 插件安装与使用教程

mirai-api-http项目地址:https://gitcode.com/gh_mirrors/mir/mirai-api-http

1. 项目目录结构及介绍

mirai-api-http/
├── src/
│   ├── main/
│   │   ├── kotlin/
│   │   │   └── net/
│   │   │       └── mamoe/
│   │   │           └── mirai/
│   │   │               └── api/
│   │   │                   └── http/
│   │   │                       ├── adapter/
│   │   │                       ├── auth/
│   │   │                       ├── event/
│   │   │                       ├── message/
│   │   │                       ├── network/
│   │   │                       ├── session/
│   │   │                       └── utils/
│   │   └── resources/
│   │       └── META-INF/
│   └── test/
│       └── kotlin/
│           └── net/
│               └── mamoe/
│                   └── mirai/
│                       └── api/
│                           └── http/
├── build.gradle.kts
├── settings.gradle.kts
├── README.md
└── LICENSE

目录结构介绍

• src/main/kotlin/: 包含项目的核心代码，包括适配器、认证、事件处理、消息处理、网络通信、会话管理等模块。
• src/test/kotlin/: 包含项目的测试代码。
• build.gradle.kts: 项目的构建脚本。
• settings.gradle.kts: 项目的设置脚本。
• README.md: 项目的说明文档。
• LICENSE: 项目的开源许可证。

2. 项目启动文件介绍

启动文件

项目的启动文件主要是通过 Mirai Console Loader (MCL) 来启动 mirai-api-http 插件。MCL 是一个用于加载和管理 Mirai 插件的工具。

启动步骤

1. 安装 MCL: 首先需要安装 Mirai Console Loader。

2. 配置 MCL: 配置 MCL 以加载 mirai-api-http 插件。

3. 启动 MCL: 使用命令行启动 MCL，命令如下：

   ./mcl -u
   

   该命令会自动更新插件并启动 Mirai Console。

3. 项目的配置文件介绍

配置文件

mirai-api-http 的配置文件位于 config/net.mamoe.mirai-api-http/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
singleMode: false

配置项说明

• adapters: 配置启用的适配器，支持 http, ws, reverse-ws, webhook。
• enableVerify: 是否开启认证流程，建议在公网连接时开启。
• verifyKey: 认证密钥，用于验证连接。
• debug: 是否开启调试信息。
• singleMode: 是否开启单会话模式，开启后接口中任何 sessionKey 不需要传递参数。

通过以上配置，可以灵活地调整 mirai-api-http 插件的行为，以满足不同的使用需求。

mirai-api-http项目地址:https://gitcode.com/gh_mirrors/mir/mirai-api-http