在前端开发中，我们很常见到需要调用其他的 API 或者后台接口来实现某些功能。而 npm 上有很多好用的插件或者库，它们能够让我们更方便地调用其他平台的 API。其中，callsplugin 是一个好用的 npm 包，提供了比较完整的 API 调用能力，同时使用也非常简单。本文将介绍 callsplugin 的使用教程以及示例代码。
callsplugin 的功能和用法
callsplugin 是一个能够实现 Web API 调用的 npm 包，它提供了以下的能力：
- 普通 GET 请求的发送和接收
- 带有参数的 GET 请求的发送和接收
- 普通 POST 请求的发送和接收
- 带有参数的 POST 请求的发送和接收
更多详细内容可以查看官方文档 callsplugin。
与其他的请求库相比，callsplugin 简单易用，同时使用也非常灵活。
安装 callsplugin
使用 npm 安装 callsplugin，执行命令：
npm install callsplugin --save
等待安装完成即可。
使用示例
下面以一个在线天气 API 为例，详细说明 callsplugin 的使用方法。今天的任务是获取北京市当前的天气情况。
发送普通 GET 请求，并获取响应
步骤：
- 在 HTML 文件中引入 callsplugin：
<script src="node_modules/callsplugin/callsplugin.js"></script>
- 发送获取天气的 GET 请求：
callsplugin.get('http://api.openweathermap.org/data/2.5/weather?q=Beijing&appid=xxxxxxxxx', function(err, data) {
if (err) {
console.log(err);
} else {
console.log(JSON.parse(data));
}
});说明：
- 在这个例子中，我们发送了一个 GET 请求到 http://api.openweathermap.org 这个网址，由于该网站需要 API Key（即 appid），所以需要把自己注册的 appid 替换掉上面链接中的 xxxxxxxxx。
- 如果请求成功，可以在浏览器控制台上看到返回的天气数据。
JSON.parse()方法作用是把响应中的 JSON 数据转换成 JavaScript 对象。
发送带有参数的 GET 请求，并获取响应
步骤：
- 在 HTML 文件中引入 callsplugin：
<script src="node_modules/callsplugin/callsplugin.js"></script>
- 设置请求参数和参数值，把请求参数和参数值拼接到 url 后面。
-- -------------------- ---- -------
--- ---- - ----------
--- --- - --------------------------------------------------- - ---- - -------------------
-------------------- ------------- ----- -
-- ----- -
-----------------
- ---- -
------------------------------
-
---说明：
- 我们先设置了 cityName，即北京，然后把 cityName 和 appid 拼接到 url 后面，这样便可以通过 GET 请求一次性拿到我们需要的数据。
- 可以在浏览器控制台上看到请求成功的信息和返回的数据。
发送普通 POST 请求，并获取响应
步骤：
- 在 HTML 文件中引入 callsplugin：
<script src="node_modules/callsplugin/callsplugin.js"></script>
- 设置请求的 body，然后发送 POST 请求，获取响应：
-- -------------------- ---- -------
--- ------ - ------------------------------
--- ------- - -
----- -----------
---- ---------
--
------------------------ -------- ------------- ----- -
-- ----- -
-----------------
- ---- -
------------------------------
-
---说明：
payload变量表示 POST 请求的 body，即 POST 请求需要提交的数据。JSON.parse()方法作用是把响应中的 JSON 数据转换成 JavaScript 对象。
发送带有参数的 POST 请求，并获取响应
步骤：
- 在 HTML 文件中引入 callsplugin：
<script src="node_modules/callsplugin/callsplugin.js"></script>
- 设置请求的参数和参数值，以及 body，然后发送 POST 请求，获取响应：
-- -------------------- ---- -------
--- ------ - --------------------------------------
--- -------- - -----------
--- ------- - ---------
--- ------- - -
----- ---------
---- --------
--
------------------------ -------- ------------- ----- -
-- ----- -
-----------------
- ---- -
------------------------------
-
---说明：
- 我们现在把参数和参数值拼接到了 api url 中，这样便可以通过 POST 请求一次性拿到我们需要的数据。
总结
以上就是 callsplugin 的使用方法，借助 callsplugin，我们可以在前端快速处理 Web API，请求数据并处理响应，实现前后端分离。callsplugin 还提供了其他丰富的功能，可以进一步查看官方文档。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60066c92ccdc64669dde5a44