简体中文 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

請求操作

相關文件