前言
在开发过程中，我们需要不断地对数据进行监测和分析，了解服务器及其 API 的使用情况，以便于后续优化和改进。本文将介绍一款非常好用的 npm 包 egg-swagger-stats，用于收集 egg.js 项目中 API 的统计信息，并以 Swagger 格式展现。
安装
你可以通过以下命令在项目中安装 egg-swagger-stats：
npm i egg-swagger-stats --save
使用 egg-swagger-stats
- 在认证短信API编号对对应的API路由文件中加载该插件
// {app_root}/app/router.js module.exports = app => { app.router.use('/api/sms-code', require('./router/auth/sms-code')); ... };
- 安装 egg-swagger，用于生成 API 文档。
npm i egg-swagger --save
- 在 egg.js 项目的 config 文件夹中找到 middleware.js 文件，新增中间件
config.middleware = ['swagger', 'swaggerRouter', 'swaggerValidator', 'swaggerParams', 'swaggerSecurity', 'swaggerUI', 'swaggerStats'];
- 在 egg.js 项目的 config 文件夹中找到 config.default.js 文件，添加如下配置信息：
-- -------------------- ---- ------- ------------------- - - -------- -------- -- ------- --- ------ ---- ------ -- ---- -------- -------- -- --- -- ------------ ------------------ --------- -- ---- -------------------------------- -------------- -- ------- -- ----- ------------- ------------------- -- --------- ---------------- ----- -- ------ --------------- ----------------- -- --------- ----------------- ----------- -- ---------------------- ------ ----- -- ------ --------- - ------------- ------- ------------ ------ ----------- ----- ------------------------- -- ------------------- ----- ------------------- ------ --------------- ----- - --展开代码
示例
在 egg.js 项目中假设有一个 user 接口，该接口的使用情况我们需要进行统计，那么我们可以使用 egg-swagger-stats 进行收集。
- 安装依赖
npm i egg-swagger-stats --save
- 加载中间件
module.exports = (app) => { const { router, controller } = app; const stats = require("egg-swagger-stats").getMiddleware(); router.use(stats); // 加载 egg-swagger-stats 中间件 router.post("/api/user", controller.user.getUserInfo); // 注册 user 接口 };
- 启动 egg.js 项目并访问 http://localhost:7001/swagger-stats/，查看统计信息。
总结
以上就是本文对 egg-swagger-stats 的使用教程，了解了 egg.js 项目 API 的使用情况以及统计信息，对我们优化和改进项目具有重要的指导意义。希望本篇文章能对您有所帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60067350890c4f72775838ba
