Limiter

Limiter middleware for Fiber used to limit repeated requests to public APIs and/or endpoints such as password reset etc. Also useful for API clients, web crawling, or other tasks that need to be throttled.

Signatures

  1. func New(config ...Config) fiber.Handler

Examples

Import the middleware package that is part of the Fiber web framework

  1. import (
  2.   "github.com/gofiber/fiber/v2"
  3.   "github.com/gofiber/fiber/v2/middleware/limiter"
  4. )

After you initiate your Fiber app, you can use the following possibilities:

  1. // Default middleware config
  2. app.Use(limiter.New())
  4. // Or extend your config for customization
  5. app.Use(limiter.New(limiter.Config{
  6.     Next: func(c *fiber.Ctx) bool {
  7.         return c.IP() == "127.0.0.1"
  8.     },
  9.     Max:          20,
  10.     Duration:     30 * time.Second,
  11.     Key:          func(c *fiber.Ctx) string {
  12.         return c.Get("x-forwarded-for")
  13.     },
  14.     LimitReached: func(c *fiber.Ctx) error {
  15.         return c.SendFile("./toofast.html")
  16.     },
  17. }))

Config

  1. // Config defines the config for middleware.
  2. type Config struct {
  3.     // Next defines a function to skip this middleware when returned true.
  4.     //
  5.     // Optional. Default: nil
  6.     Next func(c *fiber.Ctx) bool
  8.     // Max number of recent connections during `Duration` seconds before sending a 429 response
  9.     //
  10.     // Default: 5
  11.     Max int
  13.     // Duration is the time on how long to keep records of requests in memory
  14.     //
  15.     // Default: time.Minute
  16.     Duration time.Duration
  18.     // Key allows you to generate custom keys, by default c.IP() is used
  19.     //
  20.     // Default: func(c *fiber.Ctx) string {
  21.     //   return c.IP()
  22.     // }
  23.     Key func(*fiber.Ctx) string
  25.     // LimitReached is called when a request hits the limit
  26.     //
  27.     // Default: func(c *fiber.Ctx) error {
  28.     //   return c.SendStatus(fiber.StatusTooManyRequests)
  29.     // }
  30.     LimitReached fiber.Handler
  31. }

Default Config

  1. var ConfigDefault = Config{
  2.     Next:     nil,
  3.     Max:      5,
  4.     Duration: time.Minute,
  5.     Key: func(c *fiber.Ctx) string {
  6.         return c.IP()
  7.     },
  8.     LimitReached: func(c *fiber.Ctx) error {
  9.         return c.SendStatus(fiber.StatusTooManyRequests)
  10.     },
  11. }