Koa Rate Limit By Redis

Note: This module is based on express-rate-limit.

Install

npm install --save koa-ratelimit-redis

Usage

1const Redis = require('ioredis')
2const RateLimit = require('koa-ratelimit-redis').RateLimit
3const RedisStore = require('koa-ratelimit-redis').RedisStore
4const Koa = require('koa')
5const router = require('koa-router')()
6
7const client = new Redis({
8    host: '127.0.0.1',
9    port: '6379',
10    db: 0,
11})
12
13function skip(ctx) {
14    return false
15}
16
17function koaHandler(ctx) {
18    ctx.body = {
19        ok: false,
20        code: 'RATE_LIMIT',
21        msg: 'RATE_LIMIT',
22    }
23}
24
25function defaultRateLimiter(max = 5, expiry = 60, handler = koaHandler) {
26    return new RateLimit({
27        store: new RedisStore({
28            client,
29            expiry: expiry,
30            prefix: 'rl:'
31        }),
32        keyGenerator(ctx) {
33            return `default::${ctx.method}:${ctx.path}:${ctx.ip}`
34        },
35        max: max,
36        statusCode: 200,
37        handler,
38        skip,
39    })
40}
41
42function doHello(ctx) {
43    ctx.body = 'hello world'
44}
45
46const app = new Koa()
47
48router.get('/hello', defaultRateLimiter(), doHello)
49router.get('/world', defaultRateLimiter(1, 30, (ctx) => {
50    ctx.body = {
51        msg: 'RATE_LIMIT'
52    }
53}), doHello)
54
55app.use(router.middleware())
56
57app.listen(8080)
58