History

Luis Alvarez D e28fd50441 Include utm_source on example links to vercel.com (#21305 )		2021-01-19 07:28:54 +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	Add new example for rate limiting API routes. (#19509 )	2021-01-04 22:19:31 +00:00
README.md	Include utm_source on example links to vercel.com (#21305 )	2021-01-19 07:28:54 +00:00
styles.module.css	Add new example for rate limiting API routes. (#19509 )	2021-01-04 22:19:31 +00:00

README.md

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:

How to use

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

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

Deploy it to the cloud with Vercel (Documentation).