1
0
mirror of https://github.com/actix/actix-extras.git synced 2024-11-23 23:51:06 +01:00
actix-extras/actix-limitation
Rob Ede 977e3141c9
limitation clean up (#232)
* add license links to -limitation

* move tests to inline mod

* use cow str for limiter parameters

* add docs to all limitation items

* rename builder methods

* fix ignored tests

* update changelog

* fix ci
2022-03-20 00:40:34 +00:00
..
src limitation clean up (#232) 2022-03-20 00:40:34 +00:00
tests limitation clean up (#232) 2022-03-20 00:40:34 +00:00
Cargo.toml limitation clean up (#232) 2022-03-20 00:40:34 +00:00
CHANGES.md limitation clean up (#232) 2022-03-20 00:40:34 +00: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 limitation clean up (#232) 2022-03-20 00:40:34 +00: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.1.4"
use std::time::Duration;
use actix_web::{get, web, App, HttpServer, Responder};
use actix_limitation::{Limiter, RateLimiter};

#[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::build("redis://127.0.0.1")
            .cookie_name("session-id".to_owned())
            .session_key("rate-api-id".to_owned())
            .limit(5000)
            .period(Duration::from_secs(3600)) // 60 minutes
            .finish()
            .expect("Can't build actix-limiter"),
    );

    HttpServer::new(move || {
        App::new()
            .wrap(RateLimiter)
            .app_data(limiter.clone())
            .service(index)
    })
    .bind("127.0.0.1:8080")?
    .run()
    .await
}