Description

An in-memory Gin middleware to limit access rate by custom key and rate.

It depends on two library:

• golang.org/x/time/rate: rate limit
• github.com/patrickmn/go-cache: expire limiter related key

installation

go get -u github.com/yangxikun/gin-limit-by-key

Example

package main

import (
    limit "github.com/yangxikun/gin-limit-by-key"
    "github.com/gin-gonic/gin"
    "golang.org/x/time/rate"
)

func main() {
	r := gin.Default()

	r.Use(limit.NewRateLimiter(func(c *gin.Context) string {
		return c.ClientIP() // limit rate by client ip
	}, func(c *gin.Context) (*rate.Limiter, time.Duration) {
		return rate.NewLimiter(rate.Every(100*time.Millisecond), 10), time.Hour // limit 10 qps/clientIp and permit bursts of at most 10 tokens, and the limiter liveness time duration is 1 hour
	}, func(c *gin.Context) {
		c.AbortWithStatus(429) // handle exceed rate limit request
	}))

	r.GET("/", func(c *gin.Context) {})

	r.Run(":8888")
}