在Node.js里如何调用外部API

在Node.js中调用外部API的主要方式包括使用内置的http和https模块、使用第三方库如axios或request、利用fetch接口（Node.js 17+或使用第三方库）。其中，使用axios是目前最为流行且简洁的方式，它支持Promise API，使得异步操作更加便捷。

一、使用http或https模块

Node.js的核心模块http和https提供了底层的HTTP接口，可以实现对外部API的请求。

创建HTTP请求

const http = require('http');

const options = {
  hostname: 'example.com',
  port: 80,
  path: '/api/data',
  method: 'GET'
};
const req = http.request(options, (res) => {
  let data = '';
  res.on('data', (chunk) => {
    data += chunk;
  });
  res.on('end', () => {
    console.log(JSON.parse(data));
  });
});
req.on('error', (e) => {
  console.error(`Problem with request: ${e.message}`);
});
req.end();

处理HTTPS请求

由于https模块几乎与http模块相同，替换为require('https')即可管理HTTPS请求。

二、使用第三方库axios

axios是一个基于Promise的HTTP客户端，适用于Node.js和浏览器，提供了易用的API和拦截器等强大功能。

安装axios

使用npm或yarn来安装axios：

npm install axios

或

yarn add axios

发送GET请求

const axios = require('axios');

axios.get('https://example.com/api/data')
  .then(response => {
    console.log(response.data);
  })
  .catch(error => {
    console.error(error);
  });

发送POST请求

axios.post('https://example.com/api/data', {

  key1: 'value1',
  key2: 'value2'
})
.then(response => {
  console.log(response.data);
})
.catch(error => {
  console.error(error);
});

三、使用fetch接口

Node.js从版本17开始内置了全局的fetch接口。如果使用的Node.js版本较低，也可以通过安装node-fetch库来使用。

在Node.js中使用内置fetch

假如Node.js版本支持，则直接使用fetch：

fetch('https://example.com/api/data')

  .then(response => response.json())
  .then(data => console.log(data))
  .catch(error => console.error(error));

通过第三方库使用fetch

const fetch = require('node-fetch');

fetch('https://example.com/api/data')
  .then(response => response.json())
  .then(data => console.log(data))
  .catch(error => console.error(error));

四、处理响应和错误

无论选择哪种方法去调用外部API，处理响应和错误是不可避免的。

处理响应

// 使用 axios 作为示例

axios.get('https://example.com/api/data')
  .then(response => {
    if (response.status === 200) {
      console.log('Data retrieved successfully.');
      console.log(response.data);
    } else {
      console.error('Received a non-200 status code.');
    }
  })
  .catch(error => {
    console.error(error);
  });

处理错误

处理错误时，需要考虑网络错误、API返回的错误状态码以及可能的异常。

axios.get('https://example.com/api/data')

  .then(response => {
    console.log(response.data);
  })
  .catch(error => {
    if (error.response) {
      // 请求已发出，但服务器响应的状态码不在 2xx 范围
      console.error(`Received a status code: ${error.response.status}`);
    } else if (error.request) {
      // 已发送请求但未收到响应
      console.error(error.request);
    } else {
      // 发送请求时出错
      console.error('Error:', error.message);
    }
  });

调用外部API时应该考虑网络的稳定性和API的可用性，避免单个API请求冲击性能或稳定性。可以使用超时设置、重试机制或者并发控制来提升系统的健壮性。此外，确保敏感数据的安全，如在发送API请求时正确处理API密钥等敏感信息，是调用外部API时的重要考虑因素。

相关问答FAQs：

1. 如何在Node.js中使用外部API进行数据交互？
Node.js提供了丰富的模块和函数，可以方便地调用外部API进行数据交互。首先，你需要使用require函数导入HTTP模块，并创建一个HTTP客户端对象，然后使用该对象发送HTTP请求。可以使用http.request()方法来发送GET、POST等各种类型的请求，并设置请求头部信息、携带参数等。通过监听response事件可以获取到API返回的数据。最后，使用response.on('end', ...)事件处理返回的数据和错误信息。通过这种方式，你可以轻松地在Node.js中调用外部API并获取返回结果。

2. 如何处理异步请求的结果并保证代码的可读性和可维护性？
在Node.js中，异步请求的结果通常通过回调函数来处理。为了保证代码的可读性和可维护性，我们可以使用Promise或Async/AwAIt等方法来处理异步请求的结果。通过使用Promise的then和catch方法，可以将逻辑分离成逐步处理错误和结果的几个步骤。另外，使用Async/Await语法糖可以将异步请求的处理过程转换为类似同步代码的形式，使得代码更加直观且易于理解。同时，合理设置错误处理的机制，使用try-catch语句块来捕获并处理异常情况，对于不同的错误类型提供相应的错误提示。

3. 有没有现成的Node.js模块可以用来简化与外部API的交互？
是的，Node.js生态圈中有很多可以用来简化与外部API交互的模块，比如axios和request等。这些模块提供了简洁而强大的API，可以处理HTTP请求、数据转换和错误处理等功能。使用这些模块，你可以快速地创建HTTP请求、设置请求头部信息、处理数据和错误等操作，大大简化了与外部API的交互过程。另外，这些模块也提供了丰富的配置选项和插件机制，可以满足不同场景下的需求。无论是处理RESTful API、SOAP API，还是支持OAuth、JWT等认证机制，这些模块都能帮助你轻松地完成。

最后建议，企业在引入信息化系统初期，切记要合理有效地运用好工具，这样一来不仅可以让公司业务高效地运行，还能最大程度保证团队目标的达成。同时还能大幅缩短系统开发和部署的时间成本。特别是有特定需求功能需要定制化的企业，可以采用我们公司自研的企业级低代码平台：织信Informat。 织信平台基于数据模型优先的设计理念，提供大量标准化的组件，内置AI助手、组件设计器、自动化（图形化编程）、脚本、工作流引擎（BPMN2.0）、自定义API、表单设计器、权限、仪表盘等功能，能帮助企业构建高度复杂核心的数字化系统。如ERP、MES、CRM、PLM、SCM、WMS、项目管理、流程管理等多个应用场景，全面助力企业落地国产化/信息化/数字化转型战略目标。 版权声明：本文内容由网络用户投稿，版权归原作者所有，本站不拥有其著作权，亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容，请联系我们微信：Informat_5 处理，核实后本网站将在24小时内删除。