插件开发入门

使用独立 SDK 开始第一个插件项目。

准备环境

当前开发工具版本为 0.1.16,Host API / Python SDK / 前端 SDK 为 0.1.12。开发包声明 Python 3.11+、Node.js 22.12–24;具体版本组合仍应按项目要求验证。

  1. 从开发工具下载页下载 ZIP,并核对 SHA-256。
  2. 解压到独立目录,先阅读 README 和包内的「公开插件开发」规范与入门。
  3. 创建 Python 虚拟环境并安装包内 requirements.lock;在 Uivue/frontend/app 中执行 npm ci。

开发包不包含 Python、Node.js、浏览器或全部依赖的离线镜像,首次准备依赖需要可用包源。

创建与检查

以下命令在开发包根目录运行,python 应指向已准备的虚拟环境。输出目录必须是不存在的新目录。

python dev.py init --id acme.notes --kind business --output ../my-plugin
python dev.py check --project ../my-plugin --output ../check.json
python dev.py preview --project ../my-plugin
python dev.py accept --project ../my-plugin --output ../accept.json

提供 integration、theme、business、device、flow 五类模板。设备模板使用模拟驱动,正式使用前需实现实际协议并完成真机验收。

从预览到交付

模拟预览用于验证声明范围内的界面和 API,不连接生产数据库或真实硬件。真实鉴权、审计、迁移及插件 API 联调需要发布方提供与宿主提交匹配的后端测试运行包。

本页提供的 SDK ZIP 不包含后端测试运行包。请联系发布方获取匹配运行环境;插件的正式组装和生产发布仍由维护人员执行。

源码归属

公开 SDK 提供接口、检查工具和通用教学模板,使用独立教学配色;官方插件、官方主题及完整业务样例的源码留在私有仓库。客户自行开发的插件可以使用自己的 Git 仓库管理,并自行选择访问权限。