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

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

installBazaarWidget

从集市下载并安装指定的挂件 (Widget)。

新手提示： 这个 API 就是你在思源集市里点击挂件"安装"按钮时背后执行的操作。

注意: 此 API 需要认证、管理员权限且非只读模式。

地址

POST /api/bazaar/installBazaarWidget

请求体 (JSON)

{
  "repoURL": "挂件的 Git 仓库地址",
  "repoHash": "仓库特定提交的哈希值",
  "packageName": "挂件名称",
  "keyword": "可选的关键词"
}

• repoURL: (string) 必填。挂件的来源 Git 仓库 URL。通常从 getBazaarWidget API 获取。
• repoHash: (string) 必填。仓库的特定 commit 哈希值，代表要安装的版本。通常从 getBazaarWidget API 获取。
• packageName: (string) 必填。要安装的挂件的名称。
• keyword: (string) 可选。用于安装成功后刷新集市挂件列表时的过滤，对安装操作本身影响不大。可以留空。

响应体 (JSON)

安装请求成功后，返回标准响应体，`data` 字段包含刷新后的集市挂件列表。

{
  "code": 0, // 0 表示安装任务启动成功
  "msg": "", // 成功时为空，失败时包含错误信息
  "data": {
    "packages": [
      // 安装后刷新得到的 *所有* 集市可用挂件列表 (针对指定 keyword)...
      // (结构同 getBazaarWidget 返回的 packages)
    ]
  }
}

注意:

• code: 0 仅表示后端接受了安装请求。实际下载和安装过程可能失败。
• 如果安装失败，code 会是非 0 值，msg 会包含错误信息。
• 安装挂件后，可能需要刷新挂件列表或相关文档才能看到。

示例

// 假设要安装名为 "simple-clock-widget" 的挂件
const repo = "https://github.com/user/siyuan-simple-clock";
const hash = "aabbccddeeff"; // 要安装的版本哈希
const pkgName = "simple-clock-widget";

// **再次警告：执行此代码会实际安装挂件，请确保来源可信！**
fetch('/api/bazaar/installBazaarWidget', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Token YOUR_API_TOKEN' // 替换为你的管理员 API Token
  },
  body: JSON.stringify({
    repoURL: repo,
    repoHash: hash,
    packageName: pkgName,
    keyword: ""
  })
})
.then(response => response.json())
.then(data => {
  if (data.code === 0) {
    console.log('挂件安装请求成功，后台正在处理...');
    // 可以根据需要处理返回的 packages 数据，例如刷新界面
  } else {
    console.error('挂件安装失败:', data.msg);
    // 向用户显示错误信息 data.msg
  }
})
.catch(error => console.error('请求错误:', error));