本文档非官方出品,主要由 AI 辅助编写,不保证绝对准确。如有疑问,请以 kernel/api/bazaar.go 中的源码为准。

如果您觉得本文档有帮助,可以考虑赞助支持:爱发电

getInstalledWidget

获取当前工作空间中**已安装**的挂件包列表。

新手提示: 这个 API 列出的是你已经下载到本地的挂件,而不是集市里所有可下载的挂件。方便你管理本地已安装的挂件资源。

注意: 此 API 需要认证。

地址

POST /api/bazaar/getInstalledWidget

请求体 (JSON)

{
  "keyword": "可选的关键词"
}

响应体 (JSON)

标准响应体,其中 `data.packages` 字段是一个数组,包含已安装的挂件包对象。

{
  "code": 0,
  "msg": "",
  "data": {
    "packages": [
      {
        "name": "已安装挂件包名称",
        "author": "作者",
        "version": "版本号",
        "repoURL": "来源仓库地址", // 可能为空
        "repoHash": "来源仓库哈希", // 可能为空
        "description": "描述",
        "iconURL": "图标 URL",
        "displayName": "显示名称",
        "funding": [], // 赞助信息
        "localPath": "本地安装路径", // 相对于 data 目录
        // ... 可能还有其他字段
      }
      // ... 更多已安装的挂件包
    ]
  }
}

注意: `packages` 数组中每个对象的具体字段和结构取决于后端 `model.InstalledWidgets` 函数的实现。

示例

// 获取所有已安装的挂件包
fetch('/api/bazaar/getInstalledWidget', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Token YOUR_API_TOKEN' // 替换为你的 API Token
  },
  body: JSON.stringify({ keyword: "" })
})
.then(response => response.json())
.then(data => {
  if (data.code === 0) {
    console.log('获取已安装挂件包列表成功:', data.data.packages);
    // 处理 data.data.packages 列表
  } else {
    console.error('获取已安装挂件包列表失败:', data.msg);
  }
})
.catch(error => console.error('请求错误:', error));

// 搜索已安装的包含 "calendar" 关键词的挂件包
// fetch('/api/bazaar/getInstalledWidget', {
//   method: 'POST',
//   headers: {
//     'Content-Type': 'application/json',
//     'Authorization': 'Token YOUR_API_TOKEN' // 替换为你的 API Token
//   },
//   body: JSON.stringify({ keyword: "calendar" })
// })
// // ... 后续处理同上

在线测试

实际应用案例 / Who Uses This API?

如果你的插件、主题或外部工具使用了这个 API,欢迎提交 Pull Request 将你的项目添加到下方列表!