如何检查 Web API 是否可用的标准方法

38次阅读

问题描述

作为开发人员，我参与过许多不同类型的 Web API 开发，既有用于内部使用的，也有用于公开访问的。
是否有一种标准（或事实上的标准）方法来检查 Web API 是否正在运行？
而且可能还能报告部署信息和其他元数据。
Web API 通常没有针对根 URL 的 GET 处理程序，并且常常要求对其他 URL 进行身份验证。有时我通过在代码中添加一个特定的 GET http://example.com/alive 或 GET http://example.com/hello 处理程序来解决这个问题，以便使我们的运维团队能够监视 API 并且我自己可以更快地检查它是否在运行。如果有一种更… 官方的方式就太好了。 (:

解决方案

请注意以下操作注意版本差异及修改前做好备份。

方案1：使用标准健康检查端点

一种常见的方法是为你的 Web API 添加一个专门的健康检查（Health Check）端点。健康检查端点是一个特定的 URL，用于验证服务是否正常运行。这是一个标准的做法，许多 Web 框架和服务器都支持。

以下是如何实现的步骤：
1. 在你的 Web API 代码中，添加一个用于健康检查的新路由或端点。
2. 在该路由或端点中，编写一些简单的逻辑来确定 API 是否正常运行。这可以包括数据库连接测试、关键依赖项检查等。
3. 当访问健康检查端点时，返回一个适当的响应，指示 API 是否健康。

示例（基于 Express.js 框架）：

const express = require('express');
const app = express();

// 添加健康检查端点
app.get('/health', (req, res) => {
  // 在此处执行健康检查逻辑
  const isHealthy = true; // 根据实际情况设置健康状态
  if (isHealthy) {
    res.status(200).json({ status: 'ok' });
  } else {
    res.status(500).json({ status: 'error' });
  }
});

// 其他路由和逻辑...

// 启动服务器
const port = process.env.PORT || 3000;
app.listen(port, () => {
  console.log(`Server is running on port ${port}`);
});