@4dims/express-status-monitor 中文文档教程

Question

express-api-monitor

一个简单的中间件，返回 API 和相关服务的可用性。

Getting started

安装方式：

npm install --save @4dims/express-status-monitor

在您的 Express 应用程序中使用它：

const app = require('express')();
const statusMonitor = require('@4dims/express-status-monitor');

// Default
app.use(statusMonitor());

// With DB Monitor (Mongoose / Sequelize)

// With Custom URL Path
app.use(status({ path: '/api/status', db: true }));

// respond with "hello world" when a GET request is made to the homepage
app.get('/', function(req, res) {
    res.send('hello world');
});

app.listen(3000, function () {
    console.log('Example app listening on port 3000!')
});

Options

Custom URL Path

{ path: '/status'}

API Monitoring: Enable/Disable

{ api: true }

DB Monitoring: Enable/Disable

{ db: true }

如果 DB 设置为 true，则应提供一个 DB 实例

• Mongoose { mongoose: mongoose }
• Sequelize { sequelize: sequelize }

DB Monitoring support

• [x] Mongoose ORM (MongoDB)
• [x] Sequelize ORM (MySQL, PostgreSQL, SQlite, …)
• [ ] MongoDB (coming soon)

Extras

您可以使用 extras 属性返回任何 JSON 数据

{
    extras: {
        infoA: 1234
        infoB: 1234
        infoC: 'somethin'
    }
}

Feedback

欢迎提出建议或改进！ 如果您想提供帮助，请打开问题。

Author

Piraveen 卡马拉塔斯 https://github.com/piraveen