6d8b2cd350
Converted `api-routes-rate-limit` example to TypeScript to match Contribution docs. - Removed dead/non-standard/typo links for "Deploy You Own ▲" and "View Source" ## Documentation / Examples - [X] Make sure the linting passes by running `pnpm lint` - [X] The examples guidelines are followed from [our contributing doc](https://github.com/vercel/next.js/blob/canary/contributing.md#adding-examples) |
||
|---|---|---|
| .. | ||
| pages | ||
| utils | ||
| .gitignore | ||
| next-env.d.ts | ||
| package.json | ||
| README.md | ||
| styles.module.css | ||
| tsconfig.json | ||
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
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).