Skip to content
Ianzb edited this page Oct 19, 2024 · 5 revisions

插件通用规范

插件(Addon)为zb小程序提供的扩展功能,允许使用程序API开发更多功能。 插件需满足如下形式:

  • 插件包含两部分:本体,自述文件。
    • 插件本体:
      • 格式为.zbaddon.zip(二者内容等同),内部包含Python包文件,压缩包根目录需包含__init__.py,勿仅将文件夹作为压缩包根目录下文件。
      • 需要以http(s)方式在网络上公开,以供程序下载,可使用Github Pages等方式便捷部署。
      • __init__.py需包含指定代码进行适配。
    • 自述文件:
      • 格式为.json,需要以http(s)方式在网络上公开,以供程序在线查询插件基本信息,可使用Github Pages等方式便捷部署。
      • 需按照如下格式进行适配:

{
"id": "example", // 插件独有id,注意要英文小写无特殊字符无重复。 "name": "名称", // 插件名称,将在程序内显示,可以为任意字符。
"author":"", // 插件作者 "description":"", // 插件描述 "version": "1.0.0", // 版本号,可用即可,格式较为自由。
"icon" :"链接", // 图标链接。 "file": "example.zip", // 本体文件下载网址,可为完整网址或相对网址,相对网址为相对自述文件网址。
"history": { // 历史记录,通过如下格式列举插件的更新信息。
"1.0.0": { // 版本号
"time": "XXXX年XX月XX日",// 更新日期
"log": "更新了XXX。" // 更新日志
}
}
}

函数API

组件API

设置API

日志API

Clone this wiki locally