rsnext/examples/api-routes-rate-limit
Marcos Bérgamo c3e5caf110
docs(examples): improve DX while copying command to create new project (#38410)
* docs(examples): improve DX while copy command to create new project

* chore: apply code review

Co-authored-by: Marcos Bérgamo <Marcos.Bergamo@refinitiv.com>
Co-authored-by: JJ Kasper <jj@jjsweb.site>
2022-07-26 21:57:48 -05:00
..
pages Convert api-routes-rate-limit example to TypeScript (#38393) 2022-07-08 04:17:08 +00:00
utils Convert api-routes-rate-limit example to TypeScript (#38393) 2022-07-08 04:17:08 +00:00
.gitignore Update default gitignore templates (#39051) 2022-07-26 20:08:40 -05:00
next-env.d.ts Convert api-routes-rate-limit example to TypeScript (#38393) 2022-07-08 04:17:08 +00:00
package.json Convert api-routes-rate-limit example to TypeScript (#38393) 2022-07-08 04:17:08 +00:00
README.md docs(examples): improve DX while copying command to create new project (#38410) 2022-07-26 21:57:48 -05:00
styles.module.css Add new example for rate limiting API routes. (#19509) 2021-01-04 22:19:31 +00:00
tsconfig.json Convert api-routes-rate-limit example to TypeScript (#38393) 2022-07-08 04:17:08 +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
yarn create next-app --example api-routes-rate-limit api-routes-rate-limit-app
pnpm create next-app --example api-routes-rate-limit api-routes-rate-limit-app

Deploy it to the cloud with Vercel (Documentation).