Swagger-Stats 使用指南

最新推荐文章于 2024-11-03 09:13:59 发布

原创最新推荐文章于 2024-11-03 09:13:59 发布 · 1k 阅读

CC 4.0 BY-SA版权

Swagger-Stats 使用指南

swagger-stats API Observability. Trace API calls and Monitor API performance, health and usage statistics in Node.js Microservices. 项目地址: https://gitcode.com/gh_mirrors/sw/swagger-stats

项目介绍

Swagger-Stats 是一个用于增强 API 可观测性的工具，专为基于 Node.js 的微服务设计。它能够跟踪 API 请求与响应，提供详细的健康检查及使用统计信息。通过自动检测基于 Express, Fastify, Koa, Hapi 或 Restify 的路由，Swagger-Stats 能够匹配 API 操作，且支持通过提供 Swagger（OpenAPI 规范）进一步细化追踪和统计。此项目采用 MIT 许可证发布，并在 GitHub 上维护活跃社区。

特性：
- 自动收集每种 API 操作的请求与响应统计。
- 支持基于 Swagger 规范匹配 API 请求。
- 内置仪表板供即时监控，无需额外基础设施。
- 整合 Elasticsearch 和 Kibana 进行高级分析和可视化。
- 支持 Prometheus 格式指标，集成到Prometheus和Grafana中进行监控和报警设置。

项目快速启动

要快速启用 Swagger-Stats，首先需要安装对应的依赖：

npm install swagger-stats --save
npm install prom-client@12 --save # 如果尚未安装 prom-client，它作为 Swagger-Stats 的同行依赖。

接下来，在 Express 应用中启用 Swagger-Stats：

const express = require('express');
const swStats = require('swagger-stats');
const app = express();

// 假设你有一个 swagger.json 文件
const apiSpec = require('./swagger.json');

app.use(swStats.getMiddleware({ swaggerSpec: apiSpec }));

app.listen(3000, () => {
    console.log("App listening on port 3000");
});

访问 http://localhost:3000/swagger-stats/ 查看实时的 API 监控数据。