1
0
mirror of https://github.com/actix/actix-extras.git synced 2024-11-23 23:51:06 +01:00
actix-extras/actix-limitation
2023-09-16 03:36:29 +01:00
..
src apply imports_granularity fmt rule 2022-09-11 21:55:40 +01:00
tests clippy 2023-01-07 01:04:16 +00:00
Cargo.toml chore(actix-limitation): prepare release 0.5.1 2023-09-16 03:36:29 +01:00
CHANGES.md chore(actix-limitation): prepare release 0.5.1 2023-09-16 03:36:29 +01:00
LICENSE-APACHE limitation clean up (#232) 2022-03-20 00:40:34 +00:00
LICENSE-MIT limitation clean up (#232) 2022-03-20 00:40:34 +00:00
README.md chore(actix-limitation): prepare release 0.5.1 2023-09-16 03:36:29 +01:00

actix-limitation

Rate limiter using a fixed window counter for arbitrary keys, backed by Redis for Actix Web.
Originally based on https://github.com/fnichol/limitation.

crates.io Documentation Apache 2.0 or MIT licensed Dependency Status

Examples

[dependencies]
actix-web = "4"
actix-limitation = "0.5"
use actix_limitation::{Limiter, RateLimiter};
use actix_session::SessionExt as _;
use actix_web::{dev::ServiceRequest, get, web, App, HttpServer, Responder};
use std::{sync::Arc, time::Duration};

#[get("/{id}/{name}")]
async fn index(info: web::Path<(u32, String)>) -> impl Responder {
    format!("Hello {}! id:{}", info.1, info.0)
}

#[actix_web::main]
async fn main() -> std::io::Result<()> {
    let limiter = web::Data::new(
        Limiter::builder("redis://127.0.0.1")
            .key_by(|req: &ServiceRequest| {
                req.get_session()
                    .get(&"session-id")
                    .unwrap_or_else(|_| req.cookie(&"rate-api-id").map(|c| c.to_string()))
            })
            .limit(5000)
            .period(Duration::from_secs(3600)) // 60 minutes
            .build()
            .unwrap(),
    );
    HttpServer::new(move || {
        App::new()
            .wrap(RateLimiter::default())
            .app_data(limiter.clone())
            .service(index)
    })
    .bind(("127.0.0.1", 8080))?
    .run()
    .await
}