# @budibase/sdk 中文文档

规范地址：https://npmcn.com/package/%40budibase/sdk/

版本：3\.50\.0
npm 元数据更新时间：2026-10-19T08:14:03.639Z
中文译文更新时间：2026-11-08T19:48:32.998Z
软件包许可：MPL-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40budibase/sdk
原文对照：https://npmcn.com/package/%40budibase/sdk/?lang=original

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：20.3 kB，7 个文件
- 模块格式：ES Module
- TypeScript 类型：未声明
- 运行依赖：0 个
- 首次发布：2022-09-26T14:58:46.606Z
- 最新版本发布：2026-10-19T08:14:03.311Z
- 近 30 天下载量：2717（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：1802（近 12 个月 152 个）

## 中文简介

Budibase 公共 API SDK

## 安装

```sh
npm install @budibase/sdk
```

也可以使用：`pnpm add @budibase/sdk`、`yarn add @budibase/sdk`、`bun add @budibase/sdk`

## README

# Budibase 公共 API SDK

JS SDK为Budibase公共API服务.

此 SDK 是由 [斯瓦格码源](https://github.com/swagger-api/swagger-codegen)。 。 。 .

Docker用于运行生成器,因此Java不需要. Docker是生成SDK的唯一要求.

生成的代码只会在浏览器中运行. 目前无法在节点JS环境中使用.

## 示例用途

```js
import { configure, ApplicationsApi } from "@budibase/sdk"

// Configure the API client
configure({
  apiKey: "my-api-key",
  host: "https://my.budibase.app"
})

// Search for an app.
// We can use the promisified version...
const res = await ApplicationsApi.applicationsSearchPost({ name: "foo" })
console.log("Applications:", res.data)

// ...or the callback version
ApplicationsApi.applicationsSearchPost({ name: "foo" }, ((error, data) => {
  if (error) {
    console.error("Failed to search:", error)
  } else {
    console.log("Applications:", data.data)
  }
}))
```

## 常见问题

### @budibase/sdk 是什么？

Budibase 公共 API SDK

### 如何安装 @budibase/sdk？

在项目目录运行 npm install @budibase/sdk，或使用 pnpm add / yarn add / bun add。

### @budibase/sdk 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/budibase\_\_sdk 是否存在。

### @budibase/sdk 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @budibase/sdk 可以商用吗？

@budibase/sdk 使用 MPL-2\.0 许可。弱 Copyleft：可以商用，也可以和闭源代码一起使用；但如果分发时修改了 MPL 授权的文件，这些文件的修改需以 MPL 开源。以上为概括，不构成法律意见，请以许可原文为准。

### @budibase/sdk 的下载量有多少？

根据 npm 官方下载统计，@budibase/sdk 在 2026/10/09 – 2026/11/07 这 30 天内被下载 2,717 次，日均约 91 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @budibase/sdk 还在维护吗？

最新版本 3\.50\.0 发布于 2026/10/19（20 天前）；至今共发布 1802 个版本，其中过去 12 个月发布了 152 个；首次发布于 2022/09/26。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。