Feature Request: Support per-route limit configuration

[kevcomparadise]

Hi,

Thanks for the amazing work — this package is incredibly useful for us!
Would it be possible to support per-route configuration limits? For example

/api/endpoint-a -> {
  max: 6,
  duration: 1200,
}

/api/endpoint-b -> {
  max: 3,
  duration: 240,
} 

This would allow us to fine-tune rate limits depending on the endpoint.
I’d be happy to contribute if that helps!

Thanks again 🙏

[rrd108]

Thanks so much for opening this issue! I completely agree that per-route rate limiting would be a powerful and essential feature for nuxt-api-shield. It's a great suggestion that significantly increases the utility of the package.

I'm definitely interested in implementing this. Since you mentioned you'd be happy to contribute:

Would you be open to helping drive this feature forward? Any of the following contributions would be extremely valuable:

• Failing Tests: Writing a few unit tests that describe the desired per-route behavior (e.g., one route respects its strict limit while another route respects its relaxed limit). This defines the specification clearly.
• Implementation: If you'd like to, you are welcome to submit a Pull Request with the working implementation.
• Documentation: Writing up the proposed configuration structure and usage examples for the documentation.

Please let me know if you are interested in tackling any of these parts!

Thanks again for using and contributing to the package.

[kevcomparadise]

Thanks for the quick reply!

I’m currently working on the implementation and I’ll write the tests alongside it to clearly define the expected per-route behavior.

I’m totally fine documenting the feature as well. Before finalizing the implementation,

Let me know if you’d like to review the proposed config structure first, or if I should open a draft PR so we can iterate together.

Thanks again!

[rrd108]

My preferred approach is to define a routes array within the rateLimiter config that supports mixed types to keep simple route configuration clean:

The routes array items could be:

• A string (the API path) to apply the global default rate limits.
• An object to specify custom rate limit options (max, duration, etc.) for that path.

// Example in nuxt.config.js
rateLimiter: {
  // Global defaults
  max: 10,
  duration: 60000, // 10 requests per 60 seconds
  
  routes: [
    // 1. String: This route uses the global defaults (10 reqs / 60s)
    '/api/default-route', 

    // 2. Object: This route overrides the limits (3 reqs / 120s)
    { path: '/api/login', max: 3, duration: 120000 }, 
  ]
}

This ensures minimal configuration is needed for most endpoints.

What do you think of this approach? I'm fully open to discussing alternative structures if you believe there is a cleaner or more efficient way to handle this routing configuration.

If you are happy with this, feel free to start on the failing tests or the implementation in a Pull Request!