npm 包 workplus-api 使用教程

阅读时长 3 分钟读完

什么是 workplus-api?

workplus-api 是一个基于 Promise 的轻量级 JavaScript 库,提供了封装好的 WorkPlus API 请求方法,可以用来简化企业通讯录、知识库、工作流等 WorkPlus 官网的 API 请求处理。

安装

你可以通过 npm 安装 workplus-api:

使用方法

引入 workplus-api

在用之前,先把它引入我们的项目:

初始化

workplus-api 需要一些参数,比如 client_id 创建一个新的实例来进行初始化:

请求 API

workplus-api 封装了所有 WorkPlus API,并提供了一个 API 请求统一的方法,如下:

其中,method 为请求方法,支持 get、post、put、delete 等。

path 为 API 请求的路径,比如 /v1/users/self、/v1/approvals/my、/v1/docs/search 等。

data 为传入 API 请求的参数。可传可不传,根据不同的 API 需求来定。

示例

-- -------------------- ---- -------
------ ----------- ---- ---------------

----- --- - --- -------------
  ---------- ----- --- -----------
  -------------- ----- --- ---------------
---

------------------ --------------------------------- -- -
  ---------------------------
---------------- -- -
  -------------------
---

以上代码将会请求 /v1/users/self API 并返回对应的用户信息。

你可以在 WorkPlus 官网开发者中心查阅更多 API 请求示例,来了解 workplus-api 的参数传入方式。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/600671188dd3466f61ffe748

纠错
反馈