https://github.com/gladmo/grate
Grate is simple rate limit middleware for Go.
https://github.com/gladmo/grate
gin-middleware limiter limiter-set
Last synced: 5 months ago
JSON representation
Grate is simple rate limit middleware for Go.
- Host: GitHub
- URL: https://github.com/gladmo/grate
- Owner: gladmo
- License: mit
- Created: 2021-05-24T10:40:47.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2021-06-03T06:25:40.000Z (about 5 years ago)
- Last Synced: 2024-06-20T06:28:16.016Z (about 2 years ago)
- Topics: gin-middleware, limiter, limiter-set
- Language: Go
- Homepage:
- Size: 1.65 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# grate
Grate is simple rate limit middleware for Go.
## Usage
```go
package main
import (
"context"
"fmt"
"sync"
"time"
"github.com/gladmo/grate"
)
func main() {
// new rate limiter with ttl
lim := grate.NewRateLimiter(1, 1, time.Second*10)
var wg sync.WaitGroup
// Limit for each key
for i := 0; i < 100; i++ {
wg.Add(1)
go func(key string) {
defer wg.Done()
// each key allot a *rate.Limiter
err := lim.Wait(key, context.Background())
if err != nil {
panic(err)
}
fmt.Println(fmt.Sprintf("idx:%s, now: %s", key, time.Now()))
}(fmt.Sprint(i % 3))
}
wg.Wait()
}
```
### gin middleware
```go
package main
import (
"net/http"
"time"
"github.com/gin-gonic/gin"
"github.com/gladmo/grate"
gingrate "github.com/gladmo/grate/gin-grate"
)
func main() {
r := gin.Default()
// use gin grate ip limiter
r.Use(gingrate.IPLimiter(grate.NewRateLimiter(10, 1, time.Minute)))
r.GET("/", func(c *gin.Context) {
c.String(http.StatusOK, "ok")
})
err := r.Run("0.0.0.0:8910")
if err != nil {
panic(err)
}
}
```