Nuxt Rate Limit
npm install nuxt-rate-limit/api endpoint.
nuxt-rate-limit dependency to your project
sh
pnpm add -D nuxt-rate-limit
yarn add --dev nuxt-rate-limit
npm install --save-dev nuxt-rate-limit
`
2. Add nuxt-rate-limit to the modules section of nuxt.config.ts
`js
export default defineNuxtConfig({
modules: ['nuxt-rate-limit'],
})
`
That's it! You can now use Nuxt Rate Limit in your Nuxt app ✨
Options
| name | type | default | description |
| --- | --- | --- | --- |
| enabled | boolean | true | Enabled/disable the rate limit module |
| headers | boolean | true | Add x-ratelimit headers to response |
| statusMessage | string | Too many requests. Please try again in :value: seconds. | Customize error message. :value: will be replaced by seconds until reset |
| routes | object | {} | Add rate limits per route |
Default Rate Limit
By default, we add a rate limit to all of your /api routes. You can override this setting by adding /api/* to the nuxtRateLimit routes in your nuxt.config.ts:
`js
export default defineNuxtConfig({
nuxtRateLimit: {
routes: {
'/api/*': {
maxRequests: 100,
intervalSeconds: 60,
},
},
},
})
`
Different limits per route
You can also add limits per route:
`js
export default defineNuxtConfig({
nuxtRateLimit: {
routes: {
'/api/hello': {
maxRequests: 5,
intervalSeconds: 10,
},
'/api/goodbye': {
maxRequests: 15,
intervalSeconds: 60,
},
},
},
})
``