README
egg-rate-limiter
限制接口调用次数
依赖 egg-redis
Install
$ npm i egg-rate-limiter --save
Usage
// {app_root}/config/plugin.js
exports.rateLimiter = {
enable: true,
package: '@musicode/egg-rate-limiter',
};
Configuration
// {app_root}/config/config.default.js
exports.middleware = [
'rateLimiter',
]
exports.rateLimiter = {
onError: function (ctx, app) {
// 超过上限时触发
// 也可不配此回调，默认会返回 429 状态码
},
routers: {
'/a/b': {
// 举个例子，1 分钟最多调 10 次
max: 10,
duration: 60 * 1000
}
}
};
app/extend/context 对象需自行扩展一个 getter，如下：
module.exports = {
get rateLimiterId() { return '可以是用户 id、ip 或别的' }
}