Mirai HTTP API 使用教程

Mirai HTTP API 使用教程

mirai-api-httpMirai HTTP API (console) plugin项目地址:https://gitcode.com/gh_mirrors/mi/mirai-api-http

1. 项目的目录结构及介绍

Mirai HTTP API 项目的目录结构如下：

mirai-api-http/
├── src/
│   ├── main/
│   │   ├── kotlin/
│   │   │   └── net/
│   │   │       └── mirai/
│   │   │           └── api/
│   │   │               └── http/
│   │   │                   ├── adapter/
│   │   │                   ├── event/
│   │   │                   ├── message/
│   │   │                   ├── utils/
│   │   │                   └── MiraiHttpApiPlugin.kt
│   ├── test/
│   │   ├── kotlin/
│   │   │   └── net/
│   │   │       └── mirai/
│   │   │           └── api/
│   │   │               └── http/
│   │   │                   └── MiraiHttpApiPluginTest.kt
├── config/
│   └── net.mamoe.mirai-api-http/
│       └── settings.yml
├── build.gradle.kts
├── gradle.properties
├── settings.gradle.kts
└── README.md

目录结构介绍

• src/main/kotlin/net/mirai/api/http/: 包含项目的主要源代码。
  • adapter/: 适配器相关代码。
  • event/: 事件处理相关代码。
  • message/: 消息处理相关代码。
  • utils/: 工具类相关代码。
  • MiraiHttpApiPlugin.kt: 主插件文件。
• src/test/kotlin/net/mirai/api/http/: 包含测试代码。
• config/net.mamoe.mirai-api-http/settings.yml: 配置文件。
• build.gradle.kts: Gradle 构建脚本。
• gradle.properties: Gradle 属性文件。
• settings.gradle.kts: Gradle 设置文件。
• README.md: 项目说明文档。

2. 项目的启动文件介绍

项目的启动文件是 MiraiHttpApiPlugin.kt，位于 src/main/kotlin/net/mirai/api/http/ 目录下。该文件是 Mirai HTTP API 插件的主入口点，负责初始化和启动插件。

启动文件主要功能

• 初始化插件配置。
• 注册事件监听器。
• 启动 HTTP、WebSocket 等适配器。
• 处理插件的生命周期事件。

3. 项目的配置文件介绍

项目的配置文件是 settings.yml，位于 config/net.mamoe.mirai-api-http/ 目录下。该文件包含了插件的各种配置选项。

配置文件主要内容

adapters:
  - http
  - ws
enableVerify: true
verifyKey: 1234567890
debug: false
singleMode: false
cacheSize: 1000

配置项说明

• adapters: 启用的适配器，支持 http、ws 等。
• enableVerify: 是否开启认证流程。
• verifyKey: 认证密钥。
• debug: 是否开启调试信息。
• singleMode: 是否开启单 session 模式。
• cacheSize: 历史消息的缓存大小。

以上是 Mirai HTTP API 项目的目录结构、启动文件和配置文件的介绍。希望这份教程能帮助你更好地理解和使用该项目。

mirai-api-httpMirai HTTP API (console) plugin项目地址:https://gitcode.com/gh_mirrors/mi/mirai-api-http