介绍
npm 是 Node.js 的包管理器,在前端开发中变得越来越重要,同时也有越来越多的包被上传到 npm 上供开发者使用。在这篇文章中,我们将会介绍一个非常重要的 npm 包,boxsdk,它是用来连接 box.com 的官方 SDK 包,适用于在前端或者 Node.js 中使用。
安装
在使用 boxsdk 之前,你需要先安装 Node.js。然后,你可以使用下面的命令安装 boxsdk:
npm install boxsdk
用法
boxsdk 可以使用 OAuth2 进行认证,让用户授权,之后使用 token 进行认证请求。在使用之前,请先在 box.com 创建应用并获取到应用的配置项。
-- -------------------- ---- ------- ----- ------ - ------------------ ----- --- - --------------------------------- --------- ----------------- ------------- --------------------- -------- - ------------ --------------------- ----------- ------------------- ----------- ----------------------------- - --- ----- ------ - -----------------------------------
在这里,我们使用 BoxSDK.getPreconfiguredInstance()
方法来获取 SDK 实例。在 clientID
和 clientSecret
上,我们使用了 box.com 应用的一般配置,让 SDK 能够使用 OAuth2 进行认证。另外,我们还使用了 appAuth
配置项。在这里我们使用了基于 JWT 的 app 鉴权。需要注意的是,privateKey
是你 box.com 应用的密钥,而 passphrase
是你创建密钥时候的密码。
使用 SDK 实例创建 client 对象后,我们就可以使用 client 对象进行 API 请求了。在下面的例子中,我们使用了 SDK 提供的 getFolders()
方法获取到了 box.com 中的一个 Folder 对象以及 Folder 对象下所有的 Item 对象。
client.folders.getItems('01234567', {fields: 'name, size, created_at'}) .then((items) => { items.entries.forEach((item) => { console.log(item.name, item.size, item.created_at); }); });
在这里,我们只是使用 getItems()
方法进行请求,并将请求结果打印出来。在实际开发中,你可以自由定义响应结果的处理方式。
包信息
- 包名称:boxsdk
- 包描述:box.com 的官方 SDK 包,用来连接和请求 box.com 服务。
- 官方文档:box.com 开发文档
- GitHub 项目地址:box/box-node-sdk
结论
boxsdk 是一个非常方便的包,可以让我们轻松地连接和请求 box.com 的服务。在这篇文章中,我们了解了如何使用 boxsdk,包括安装、使用以及常用 API 的调用方式。如果你想在你的 web 应用或者 Node.js 应用中使用 box.com 的服务,可以考虑使用 boxsdk 进行开发。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60066c84ccdc64669dde4e6b