egg-ratelimit

[![NPM version][npm-image]][npm-url]
[![build status][travis-image]][travis-url]
[![Test coverage][codecov-image]][codecov-url]
[![David deps][david-image]][david-url]
[![Known Vulnerabilities][snyk-image]][snyk-url]
[![npm download][download-image]][download-url]

[npm-image]: https://img.shields.io/npm/v/egg-ratelimit.svg?style=flat-square
[npm-url]: https://npmjs.org/package/egg-ratelimit
[travis-image]: https://img.shields.io/travis/eggjs/egg-ratelimit.svg?style=flat-square
[travis-url]: https://travis-ci.org/eggjs/egg-ratelimit
[codecov-image]: https://img.shields.io/codecov/c/github/eggjs/egg-ratelimit.svg?style=flat-square
[codecov-url]: https://codecov.io/github/eggjs/egg-ratelimit?branch=master
[david-image]: https://img.shields.io/david/eggjs/egg-ratelimit.svg?style=flat-square
[david-url]: https://david-dm.org/eggjs/egg-ratelimit
[snyk-image]: https://snyk.io/test/npm/egg-ratelimit/badge.svg?style=flat-square
[snyk-url]: https://snyk.io/test/npm/egg-ratelimit
[download-image]: https://img.shields.io/npm/dm/egg-ratelimit.svg?style=flat-square
[download-url]: https://npmjs.org/package/egg-ratelimit

> 灵感来自于egg-ratemiter，优化支持 url search

Rate limiter for Egg.js backed by Redis.

* 支持配置路由限制访问速率 支持url search
* 支持Controller控制器内配置访问速率限制

依赖说明

$3

egg-ratelimit 版本 | egg 1.x
--- | ---
1.x | 😁
0.x | ❌

$3

开启插件

``js
// config/plugin.js
exports.ratelimit = {
enable: true,
package: 'egg-ratelimit',
};
`

使用说明

$3

`javascript
exports.ratelimit = {
// 1. 开启配置
app: true

// 2. 配置路由
router: [
{
path: '/index.html', // 路径
max: 3, // 单位时间最多访问次数
time: '1s', // 时间单位 s m h d y ...
message: '请求太频繁，请稍候再试' // 自定义错误信息
}
]
}
`

$3


`javascript
// ...

if (await ctx.Limit({ max: 5, time: '5s', message: '请求太频繁，请稍候再试' })) {
return
}

// 正常请求
return {
// ...
}

// ...
``

详细配置

请到 config/config.default.js 查看详细配置项说明。

提问交流

请到 egg issues 异步交流。

License

MIT