rsnext/examples/api-routes-rate-limit
leung018 66597be8a7
Add .yarn/install-state.gz to .gitignore (#56637)
### Reason for making this change
https://yarnpkg.com/getting-started/qa#:~:text=yarn%2Finstall%2Dstate.,your%20workspaces%20all%20over%20again.
In the official documentation of `yarn`, it is stated that `.yarn/install-state.gz` is an optimization file that developer shouldn't ever have to commit. However, currently, when running `create-next-app`, `.yarn/install-state.gz` is being commited.

### Remaining work
I apologize for only modifying one template initially to initiate the discussion first.

If this change is agreed upon,  it should be synchronized with other `.gitignore` templates. Would it be possible to follow a similar approach as in https://github.com/vercel/next.js/pull/47241? I would appreciate any assistance in syncing this change.
2023-10-18 16:34:48 +00: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 Add .yarn/install-state.gz to .gitignore (#56637) 2023-10-18 16:34:48 +00:00
next-env.d.ts Remove incorrect entries for pnpm debug log (#47241) 2023-03-26 22:26:05 -07:00
package.json Convert api-routes-rate-limit example to TypeScript (#38393) 2022-07-08 04:17:08 +00:00
README.md update example Deploy button URLs (#48842) 2023-04-26 13:31:44 -04: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).