rsnext/examples/api-routes-rate-limit
2022-05-27 21:21:40 +00:00
..
pages Add new example for rate limiting API routes. (#19509) 2021-01-04 22:19:31 +00:00
utils Add new example for rate limiting API routes. (#19509) 2021-01-04 22:19:31 +00:00
.gitignore Add new example for rate limiting API routes. (#19509) 2021-01-04 22:19:31 +00:00
package.json Update Next.js version in api rate limits example (#32326) 2021-12-09 16:19:48 +00:00
README.md Update pnpm create next-app for latest pnpm 6 and 7 (#37254) 2022-05-27 21:21:40 +00:00
styles.module.css Add new example for rate limiting API routes. (#19509) 2021-01-04 22:19:31 +00:00

API Routes Rate Limiting Example

This example uses lru-cache to implement a simple rate limiter for API routes (Serverless Functions).

Demo: https://nextjs-rate-limit.vercel.app/

curl http://localhost:3000/api/user -I
HTTP/1.1 200 OK
X-RateLimit-Limit: 10
X-RateLimit-Remaining: 9

curl http://localhost:3000/api/user -I
HTTP/1.1 429 Too Many Requests
X-RateLimit-Limit: 10
X-RateLimit-Remaining: 0

Deploy your own

Deploy the example using Vercel or preview live with StackBlitz

Deploy with Vercel

How to use

Execute create-next-app with npm, Yarn, or pnpm to bootstrap the example:

npx create-next-app --example api-routes-rate-limit api-routes-rate-limit-app
# or
yarn create next-app --example api-routes-rate-limit api-routes-rate-limit-app
# or
pnpm create next-app --example api-routes-rate-limit api-routes-rate-limit-app

Deploy it to the cloud with Vercel (Documentation).