Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/davidleitw/gin-limiter
A simple gin middleware for ip limiter based on redis.
https://github.com/davidleitw/gin-limiter
gin go golang ip-limit limit lua middleware redis redis-client
Last synced: 1 day ago
JSON representation
A simple gin middleware for ip limiter based on redis.
- Host: GitHub
- URL: https://github.com/davidleitw/gin-limiter
- Owner: davidleitw
- License: mit
- Created: 2020-07-23T19:36:15.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-06-01T20:17:03.000Z (over 1 year ago)
- Last Synced: 2024-11-14T14:29:42.291Z (2 months ago)
- Topics: gin, go, golang, ip-limit, limit, lua, middleware, redis, redis-client
- Language: Go
- Homepage:
- Size: 73.2 KB
- Stars: 31
- Watchers: 2
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
gin- limiter
A simple gin middleware for IP limiter based on redis.
### Installation
- Download
Type the following command in your terminal.
```bash
go get github.com/go-redis/redis/v8
go get github.com/davidleitw/gin-limiter
```
- Import
```go
import "github.com/go-redis/redis/v8"
import limiter "github.com/davidleitw/gin-limiter"
```
---
### Quickstart
- Create a limit middleware dispatcher object
```go
// Set redis client
rdb := redis.NewClient(&redis.Options{Addr: "localhost:6379", Password: "", DB: 0})
dispatcher, err := limiter.LimitDispatcher("24-M", 100, rdb)
if err != nil {
log.Println(err)
}
```
- Add a middleware to controlling each route.
```go
server := gin.Default()
server.POST("/ExamplePost1", dispatcher.MiddleWare("4-M", 20), func(ctx *gin.Context) {
ctx.String(http.StatusOK, "Hello ExamplePost1")
})
server.GET("/ExampleGet1", dispatcher.MiddleWare("5-M", 10), func(ctx *gin.Context) {
ctx.String(http.StatusOK, "Hello ExampleGet1")
})
err = server.Run(":8080")
if err != nil {
log.Println("gin server error = ", err)
}
```
See more examples [HERE](https://github.com/davidleitw/gin-limiter/blob/master/Example).
---
### Response
- When the total of request times is within limit, we will write data to header.
```
Return header:
X-RateLimit-Limit-global -> Request limit of a single ip can send request for the server.
X-RateLimit-Remaining-global -> Remaining times which single ip can send request for the server.
X-RateLimit-Reset-global -> Time to global limit reset.
X-RateLimit-Limit-single -> Request limit of a single ip can send request for the single route.
X-RateLimit-Remaining-single -> Remaining times which single ip can send request for the single route.
X-RateLimit-Reset-single -> Time to single route limit reset.
```
- When global limit or single route limit is reached, a `429` HTTP status code is sent.
and add the header with:
```shell
Return header:
If global remaining request time < 0
return global limit reset time.
If single remaining request time < 0
return this single route limit reset time.
```
### Reference
- https://github.com/ulule/limiter
- https://github.com/jpillora/ipfilter
- https://github.com/KennyChenFight/dcard-simple-demo
If you want to know the updated progress, please check `Ipfilter` branch.
### License
All source code is licensed under the [MIT License](./LICENSE).