Express Rate Limiter

This package is a middleware for Express.js that limits API requests per IP and blocks abusive clients. It also supports IP whitelisting for certain addresses that won't be rate-limited.

Installation

1npm install express-rate-limiter-ip

Usage

For all APIs

1
2const express = require('express');
3const rateLimiter = require('express-rate-limiter-ip');
4
5const app = express();
6
7app.use(rateLimiter({
8  windowMs: 60000, // 1 minute window
9  maxRequests: 10, // Limit each IP to 10 requests per window
10  blockDuration: 300000, // Block for 5 minutes
11  message: 'Too many requests from this IP, please try again later.', // Custom message for rate limit exceeded
12  whitelist: ['123.456.789.000'], // Example IPs that won't be rate-limited
13}));
14
15app.get('/', (req, res) => {
16  res.send('Hello, World!');
17});
18
19app.listen(3000, () => {
20  console.log('Server is running on port 3000');
21});
22

For particular APIs

1
2const api1Limiter = rateLimiter({
3  windowMs: 1 * 60 * 1000, // 1-minute window
4  max: 10, // Limit each IP to 10 requests per minute
5  message: 'Too many requests from this IP for API 1, please try again later.',
6  whitelist: ['123.456.789.000'], // Example IP that won't be rate-limited for this API
7});
8
9const api2Limiter = rateLimiter({
10  windowMs: 1 * 60 * 1000, // 1-minute window
11  max: 5, // Limit each IP to 5 requests per minute
12  message: 'Too many requests from this IP for API 2, please try again later.',
13  whitelist: ['987.654.321.000'], // Example IP that won't be rate-limited for this API
14});
15
16app.use('/api/route1', api1Limiter);
17app.use('/api/route2', api2Limiter);
18
19

Explanation of Changes:

1. Custom Message: Added a message option in the middleware configuration to provide feedback when the rate limit is exceeded.
2. IP Whitelisting: Included a whitelist option that allows you to specify IP addresses that won't be subject to rate limiting.

Feel free to modify the example IP addresses in the whitelist arrays to match your needs!