Apikeys-rs

描述

Apikeys-rs 是一个旨在简化后端服务 API 密钥管理的综合性工具包。它提供了一个直观的抽象层，用于 API 密钥存储，以及一个通用的基于密钥的速率限制器，确保与您首选的存储解决方案的无缝集成。

该库包含一个现成的 Axum 层，并包含内置的存储选项和限制器。

API 密钥存储

• 内存存储
• MongoDB 存储

速率限制器

• Redis 限制器

待办事项

• 增加测试覆盖率
• 添加更多存储接口
• 添加更多限制器
• 实现一个权重系统，使 API 调用具有自己的使用策略、限制和计算成本

目录

• 安装
• 用法
• 贡献
• 许可证

安装

cargo add apikeys-rs

基本用法

初始化存储

use apikeys_rs::{
    storage::{mongodb_storage::MongoDBStorage},
    traits::ApiKeyStorage,
    types::{ApiKey, ApiKeyLimits, ApiKeyLimit, ApiKeyRestrictions, ApiKeyStatus}
};

dotenv::dotenv().ok();
let uri = std::env::var("MONGODB_URI").expect("MONGODB_URI must be set");
let db_name = std::env::var("MONGODB_DB_NAME").expect("MONGODB_DB_NAME must be set");

let mut storage = MongoDBStorage::new(&uri, &db_name, None)
    .await
    .expect("Failed to create MongoDBStorage");

存储密钥

// [...] imports

let key = "test_key";

let api_key_config = ApiKey {
    key: key.unwrap_or("test_key".to_string()),
    limits: ApiKeyLimits {
        max_reads_per_minute: ApiKeyLimit::Limited(100),
        max_writes_per_minute: ApiKeyLimit::Limited(100),
    },
    restrictions: ApiKeyRestrictions { allowed_domains: vec!["example.com".to_string()] },
    status: ApiKeyStatus::Active,
    created_at: chrono::Utc::now(),
    updated_at: chrono::Utc::now(),
};

let result = storage.store_api_key(key, &api_key_config).await;

检索密钥

// [...] imports

let key = "test_key";

let result = storage.retrieve_api_key(key).await;

match result {
    Ok(retrieved_api_key) => {
        /* [...]  your code here */
    },
    Err(e) => {
        /* [...]  your code here */
    },
}

Redis 限制器

use apikeys_rs::{
    limiters::{RedisLimiter}
};

let redis_uri = "redis_connection_string";

let redis_limiter = RedisLimiter::new(redis_uri).expect("Unable to create redis limiter");

let api_key = /* [...] get api key from storage (see above) */;

let result = redis_limiter.use_key(&key);

match result {
    /* [...] your code here */
}

Axum 层用法

// [...] imports

// Create the API Key Storage
let api_key_storage = MongoDBStorage::new(
    std::env::var("MONGODB_URI").unwrap().as_str(),
    std::env::var("MONGODB_DB_NAME").unwrap().as_str(),
    None,
)
.await
.expect("Could not create MongoDBStorage");

// Create the API Key Limiter
let api_key_limiter = RedisLimiter::new(redis_connection_string.clone().as_str())
    .await
    .expect("Could not create RedisLimiter");

// Create the API Key Manager
let api_key_manager = KeyManager::new(api_key_storage, api_key_limiter);

// Create the API Key Axum Layer
let api_key_layer = ApiKeyLayer::new(api_key_manager);

let app = Router::new()
    .route("/verify", post(verify))
    // Configure Axum to use the Api Key layer
    .layer(api_key_layer)
    .with_state(state);

贡献

请随时提出问题和发送 PR。我们将在评论部分一起评估它们。

许可证

此项目根据 MIT 许可证 许可。