简体中文 English 繁體中文 日本語 Русский
本文为静态镜像,内容以交互版为准 在交互式文档中心打开 →

技术标准

总纲:适配器标准化指南 —— 标准化原则、标准地图、命名规则、差异处理模式与开发者 Checklist。新适配器/新能力请先读它。

本文档包含 ErisPulse 的技术标准规范,确保各组件间的一致性和兼容性。

标准文档列表

  1. 会话类型标准 - ErisPulse 会话类型定义和映射规范
  2. 事件转换标准 - 平台事件转换规范、扩展命名规范、消息段标准
  3. API 响应标准 - 适配器 API 响应格式标准及扩展要求
  4. 发送方法规范 - Send 类方法命名、参数规范及反向转换要求
  5. 请求操作规范 - 请求事件字段要求、HandleRequest DSL 及适配器实现要求
  6. API 动作标准 - OneBot12 标准 API 动作统一接口(用户/群组/频道/消息管理/文件含分片/元动作)
  7. 适配器标准化指南(总纲) - 标准化原则/工作流/命名规则 + 交互组件标准(按钮键盘/交互回调事件)与各平台映射

标准概述

ErisPulse 采用 OneBot12 作为核心事件标准,并在此基础上进行了扩展和细化。

核心原则

  1. 兼容性:所有标准都必须与 OneBot12 标准保持兼容
  2. 扩展性:平台特有功能通过前缀方式扩展,避免冲突
  3. 一致性:时间戳、ID 格式等关键字段需要统一处理
  4. 可追溯性:保留原始数据以便调试和问题排查

为什么需要标准?

1. 确保跨平台兼容

不同平台的事件格式各不相同,标准化的转换确保:

2. 规范 API 接口

统一的 API 响应格式确保:

3. 提高代码质量

标准规范帮助:

遵循标准的好处

对适配器开发者

对模块开发者

对最终用户

标准遵循检查清单

事件转换

API 响应

发送方法命名

媒体发送(Image / Voice / Video / File)

详细协议见 发送方法规范 §2.1

请求操作

相关文档