npm 包 restful-api-call 使用教程

在前端开发中，调用 RESTful API 是必不可少的任务。为方便快速地发起 API 请求并处理返回数据，可以使用 npm 包 restful-api-call。该包提供了一套简单易用的 API，可以实现对 RESTful API 的 GET、POST、PUT、DELETE 请求，并可以同时发送请求头，处理请求结果等。

安装

在使用该 npm 包之前，需要先安装：

npm install restful-api-call

使用

发送请求

首先，我们需要实例化一次 restful-api-call，可以在文件中 import 该包，并使用以下方式进行初始化：

import restfulApiCall from 'restful-api-call';

const api = restfulApiCall('http://example.com/api/'); // 初始化

此时，我们已经初始化了一个 API 实例，可以通过该实例对 RESTful API 发起请求。下面是 GET 请求的示例：

api.get('users/1')
  .then(response => {
    console.log(response)
  })
  .catch(error => {
    console.error(error)
  });

以上代码语句，我们利用了链式调用，可以通过 .then() 监听到请求响应成功返回的数据，也可以通过 .catch() 监听到请求异常时的错误信息。

同样的方式可以发 POST, PUT, DELETE 请求：

api.post('users', {name: 'Tom', age: 20})
  .then(response => {
    console.log(response)
  })
  .catch(error => {
    console.error(error)
  });

api.put('users/1', {name: 'Tom', age: 21})
  .then(response => {
    console.log(response)
  })
  .catch(error => {
    console.error(error)
  });

api.delete('users/1')
  .then(response => {
    console.log(response)
  })
  .catch(error => {
    console.error(error)
  });

自定义请求头

如果需要发送一些其他信息给服务器，例如授权信息等，可以使用 .setHeaders() 方法来设置请求头：

api.setHeaders({
  'Authorization': 'Bearer a5dbc78cd6bf79b6cca70f7eae8686cfb8e8b59d'
});

自定义请求参数

除了请求头，我们或许还想设置请求参数，同样可以使用链式调用进行设置：

api.setParams({
  token: '123456'
});

处理错误信息

使用链式调用，我们可以在最后一步使用 .catch() 处理异常信息，这部分是必不可少的。同时，我们还可以通过注册事件监听实现对所有请求结果的监控。以下是一个错误处理的示例：

api.get('users/2')
  .then(response => {
    console.log(response)
  });

api.on('responseError', error => {
  console.error(error);
});

在以上代码中，我们监听了所有请求结果的事件，如果响应有错误，就会触发 responseError 事件，进行错误信息的处理。

总结

上述便是 npm 包 restful-api-call 的基本使用方法，通过学习使用这个包，可以让我们更快捷地完成对 RESTful API 的请求，并可方便地处理请求数据。在使用时我们需要注意，这个包是基于 Promise 的，支持链式调用。在实际开发中，根据自身业务需求，可以在此基础上进行自定义封装，以适应更多业务场景。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60067356890c4f7277583c29