【亲测免费】 FastAPI-Limiter 安装和配置指南

1. 项目基础介绍和主要编程语言

项目基础介绍

FastAPI-Limiter 是一个用于 FastAPI 路由的请求速率限制工具，它通过 Lua 脚本来实现速率限制功能。该项目旨在帮助开发者轻松地在 FastAPI 应用中实现请求速率限制，以保护服务器免受过多请求的冲击。

主要编程语言

FastAPI-Limiter 主要使用 Python 语言编写。

2. 项目使用的关键技术和框架

关键技术和框架

• FastAPI: 一个现代、快速（高性能）的 Web 框架，用于构建 API，基于 Python 3.7+ 标准库类型提示。
• Redis: 一个开源的内存数据结构存储，用作数据库、缓存和消息代理。FastAPI-Limiter 使用 Redis 来存储和更新速率限制状态。
• Lua 脚本: 用于实现速率限制逻辑的脚本语言。

3. 项目安装和配置的准备工作和详细安装步骤

准备工作

在开始安装和配置 FastAPI-Limiter 之前，请确保你已经安装了以下软件：

• Python 3.7 或更高版本
• Redis 服务器
• pip（Python 包管理工具）

详细安装步骤

步骤 1: 安装 Redis 服务器

如果你还没有安装 Redis 服务器，可以通过以下命令安装：

# 使用 Docker 安装 Redis（推荐）
docker run --name my-redis-server -p 6379:6379 -d redis redis-server --loglevel warning

# 或者在本地安装 Redis
# 对于 Ubuntu/Debian 系统
sudo apt-get update
sudo apt-get install redis-server

# 对于 macOS 系统
brew install redis

步骤 2: 安装 FastAPI-Limiter

使用 pip 安装 FastAPI-Limiter：

pip install fastapi-limiter

步骤 3: 配置 FastAPI 应用

在你的 FastAPI 应用中配置 FastAPI-Limiter。以下是一个简单的示例：

import redis.asyncio as redis
import uvicorn
from contextlib import asynccontextmanager
from fastapi import Depends, FastAPI
from fastapi_limiter import FastAPILimiter
from fastapi_limiter.depends import RateLimiter

@asynccontextmanager
async def lifespan(_: FastAPI):
    redis_connection = redis.from_url("redis://localhost:6379", encoding="utf8")
    await FastAPILimiter.init(redis_connection)
    yield
    await FastAPILimiter.close()

app = FastAPI(lifespan=lifespan)

@app.get("/", dependencies=[Depends(RateLimiter(times=2, seconds=5))])
async def index():
    return {"msg": "Hello World"}

if __name__ == "__main__":
    uvicorn.run("main:app", debug=True, reload=True)

配置说明

• Redis 连接: 使用 redis.from_url 方法连接到本地 Redis 服务器。
• 速率限制器: 在路由 / 上配置了一个速率限制器，允许每 5 秒 2 次请求。

运行应用

保存上述代码到 main.py 文件中，然后在终端运行以下命令启动 FastAPI 应用：

uvicorn main:app --reload

现在，你的 FastAPI 应用已经配置了速率限制功能。你可以通过访问 http://127.0.0.1:8000/ 来测试速率限制是否生效。

总结

通过以上步骤，你已经成功安装并配置了 FastAPI-Limiter，为你的 FastAPI 应用添加了请求速率限制功能。希望这篇指南对你有所帮助！