allowPaths

[DiogoMarques2003]

Prerequisites

• [X] I have written a descriptive issue title
• [X] I have searched existing issues to ensure the feature has not already been requested

🚀 Feature Proposal

It's possible add a system like allowList, but for paths in api ?

Motivation

I want this because one plugin register one route, and on this route I can't have rate limit

Example

allowPaths: ['/api/docs', '/docs']

allowPaths: (request) => {
 //code
}

[DiogoMarques2003]

and like if i have '/api/docs/*' in array the system exclude rate limit of all paths started for this

[gurgunday]

Just a reminder that you can already register rate-limit to specific routes using Fastify’s encapsulation. It’s not exactly an allowPaths but it works just as well.

[DiogoMarques2003]

Just a reminder that you can already register rate-limit to specific routes using Fastify’s encapsulation. It’s not exactly an allowPaths but it works just as well.

How to do this ? Can you give a example pls ?

[mcollina]

const app = fastify()

app.register(async function () {
  app.register(require('@fastify/rate-limit'), {
  })

  // put all the routes to rate limit here
})

app.register(async function () {
  // put all the routes to not rate limit here
})

[DiogoMarques2003]

Hy @mcollina I already try this, but this don't work because the route is /api/docs ...

[mcollina]

I'm not sure how that prevents you to define /docs inside the other plugin.

[DiogoMarques2003]

@mcollina Because in /api/docs I don't want to have ratelimit

[mcollina]

This should work:

const app = fastify()

app.register(async function () {
  app.register(require('@fastify/rate-limit'), {
  })

  // put all the routes to rate limit here
})

app.register(async function () {
  // put all the routes to not rate limit here

  app.get('/api/docs', ()=> ...)
})

[DiogoMarques2003]

Ok, but the /api/docs in one plugin, exists some problem ?

[mcollina]

There should not be any problems.

[DiogoMarques2003]

Okok, but if I make this feature, will it be accepted?

[mcollina]

No, I don't think so.

There is even a better way to declare a route without rate limiting (https://github.com/fastify/fastify-rate-limit/blob/4b78b2efabb9abddc746cc0c88597230157403d1/index.js#L139):

app.get('/', { config: { rateLimit: false } }, () => ...)