如何优雅地处理 API 中的“页面未找到”响应？

2024-03-09 04:58:50

有效处理 API 中的“页面未找到”响应

简介

在使用 API 时，难免会遇到无效的请求，从而导致“页面未找到”的响应。处理这些响应对于向用户提供有意义的信息至关重要。本文将深入探讨如何检测和处理 API 响应中的“页面未找到”情况，并提供使用 Node.js 中的 node-fetch 模块的解决方案。

检测“页面未找到”响应

通常，无效的 API 请求会返回 JSON 格式的错误消息。然而，有些 API 会返回 HTML 页面来指示“页面未找到”的情况。要检测这种响应，我们可以利用 res.ok 属性，它在响应状态代码为 200 时返回 true。对于“页面未找到”响应，res.ok 将为 false。

获取错误消息

一旦检测到“页面未找到”响应，我们需要获取错误消息以便返回给用户。可以使用 res.text() 方法来检索 HTML 响应主体，它将返回一个包含错误消息的字符串。

返回错误消息

获取错误消息后，我们可以使用 res.send() 方法将其返回给用户。这将提供一个友好的错误消息，解释为什么请求失败了。例如：

fetch('https://example.com/api/endpoint')
  .then(res => {
    if (res.ok) {
      return res.json();
    } else {
      return res.text();
    }
  }).then(data => {
    if (typeof data === 'string') {
      console.log('页面未找到：', data);
      return res.send('抱歉，您要查找的页面不存在。');
    } else {
      // 处理 JSON 响应
    }
  });

示例

假设你在 node-fetch 中有一个名为 myFetch 的自定义函数，它用于获取 API 数据。以下示例展示了如何使用上述方法来处理“页面未找到”响应：

const myFetch = (url) => {
  return fetch(url)
    .then(res => {
      if (res.ok) {
        return res.json();
      } else {
        return res.text();
      }
    }).then(data => {
      if (typeof data === 'string') {
        console.log('页面未找到：', data);
        throw new Error('抱歉，您要查找的页面不存在。');
      } else {
        // 处理 JSON 响应
        return data;
      }
    });
};