History

Shubhan Chemburkar 6fd207f5ce Examples: Fixed the example path to correct value (#26255 ) ## Documentation / Examples - [x] Make sure the linting passes Changes in readme.md: The path to the example in ```create-next-app``` command was incorrectly specified as ```api-routes``` by the example author. Fixed this value to ```api-routes-rate-limit``` as well as app name to ```api-routes-rate-limit-app``` make this consistent with other examples. No other changes made to example.		2021-06-17 17:23:32 +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 examples to use React 17 (#26133 )	2021-06-16 16:43:26 +00:00
README.md	Examples: Fixed the example path to correct value (#26255 )	2021-06-17 17:23:32 +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

Preview

Preview the example live on StackBlitz:

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-rate-limit api-routes-rate-limit-app
# or
yarn create next-app --example api-routes-rate-limit api-routes-rate-limit-app

Deploy it to the cloud with Vercel (Documentation).