Mirrors/kararas_iris
1
0
Fork 0
mirror of https://github.com/kataras/iris.git synced 2025-12-20 19:37:03 +00:00
Code Releases Activity

rate: add 'SetIdentifier' and update example

Browse Source 
the /x/time/rate package may be replaced with the iris-contrib:master/throttler's one -- we'll see


Former-commit-id: 9d12c7bd997ef4502dc0a7bb93bcb015d9204703
This commit is contained in:
Gerasimos (Makis) Maropoulos
2020-05-03 03:53:43 +03:00
parent 71e9a84442
commit af66e7404f
2 changed files with 91 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

67
_examples/miscellaneous/ratelimit/main.go
View File

@@ -11,33 +11,68 @@ func main() {
app := newApp()
app.Logger().SetLevel("debug")
// * http://localhost:8080/v1
// * http://localhost:8080/v1/other
// * http://localhost:8080/v2/list (with X-API-Key request header)
app.Listen(":8080")
}
func newApp() *iris.Application {
app := iris.New()
// Register the rate limiter middleware at the root router.
//
// Fist and second input parameters:
// Allow 1 request per second, with a maximum burst size of 5.
//
// Third optional variadic input parameter:
// Can be a cleanup function.
// Iris provides a cleanup function that will check for old entries and remove them.
// You can customize it, e.g. check every 1 minute
// if a client's last visit was 5 minutes ago ("old" entry)
// and remove it from the memory.
rateLimiter := rate.Limit(1, 5, rate.PurgeEvery(time.Minute, 5*time.Minute))
app.Use(rateLimiter)
v1 := app.Party("/v1")
{
// Register the rate limiter middleware at the "/v1" subrouter.
//
// Fist and second input parameters:
// Allow 1 request per second, with a maximum burst size of 5.
//
// Third optional variadic input parameter:
// Can be a cleanup function.
// Iris provides a cleanup function that will check for old entries and remove them.
// You can customize it, e.g. check every 1 minute
// if a client's last visit was 5 minutes ago ("old" entry)
// and remove it from the memory.
limitV1 := rate.Limit(1, 5, rate.PurgeEvery(time.Minute, 5*time.Minute))
// rate.Every helper: 1 request per minute (with burst of 5):
// rate.Limit(rate.Every(1*time.Minute), 5)
v1.Use(limitV1)
// Routes.
app.Get("/", index)
app.Get("/other", other)
v1.Get("/", index)
v1.Get("/other", other)
}
v2 := app.Party("/v2")
{
v2.Use(useAPIKey)
// Initialize a new rate limit middleware to limit requests
// per API Key(see `useAPIKey` below) instead of client's Remote IP Address.
limitV2 := rate.Limit(1, 5, rate.PurgeEvery(time.Minute, 5*time.Minute))
v2.Use(limitV2)
v2.Get("/list", list)
}
return app
}
func useAPIKey(ctx iris.Context) {
apiKey := ctx.GetHeader("X-API-Key")
if apiKey == "" { // [validate your API Key here...]
ctx.StopWithStatus(iris.StatusForbidden)
return
}
// Change the method that rate limit matches the requests with a specific user
// and set our own api key as theirs identifier.
rate.SetIdentifier(ctx, apiKey)
ctx.Next()
}
func list(ctx iris.Context) {
ctx.JSON(iris.Map{"key": "value"})
}
func index(ctx iris.Context) {
ctx.HTML("<h1>Index Page</h1>")
}