FastAPI-Guard 开源项目最佳实践教程-优快云博客

FastAPI-Guard 开源项目最佳实践教程

fastapi-guard A security library for FastAPI that provides middleware to control IPs, log requests, and detect penetration attempts. It integrates seamlessly with FastAPI to offer robust protection against various security threats. 项目地址: https://gitcode.com/gh_mirrors/fa/fastapi-guard

1. 项目介绍

FastAPI-Guard 是一个基于 FastAPI 的轻量级权限管理系统。它提供了简单而灵活的方式来管理 API 的访问权限，支持多种认证和授权机制，如JWT、OAuth2等。FastAPI-Guard 旨在帮助开发者快速实现 API 的安全保护，无需复杂的配置和代码编写。

2. 项目快速启动

以下是快速启动 FastAPI-Guard 的步骤：

确保安装了 Python 3.7 或更高版本。

克隆项目到本地：

git clone https://github.com/rennf93/fastapi-guard.git

进入项目目录，安装依赖：

cd fastapi-guard
pip install -r requirements.txt

运行示例应用：
```
uvicorn main:app --reload
```
在浏览器中访问 http://127.0.0.1:8000，查看运行结果。

3. 应用案例和最佳实践

以下是一些使用 FastAPI-Guard 的最佳实践：

权限控制

在 app.py 中，你可以定义一个依赖项函数来检查用户权限：

from fastapi_guard import guard

async def check_user_role(user_id: int = guard.get_current_user_id()):
    if user_id != 1:  # 假设用户ID为1的是管理员
        raise HTTPException(status_code=HTTP_403_FORBIDDEN, detail="Not enough permissions")

然后，在路由中使用这个依赖项：

@app.get("/admin")
async def read_admin_data(user_id: int = guard.get_current_user_id(), check_user_role):
    return {"user_id": user_id, "access": "granted"}

JWT 认证

FastAPI-Guard 支持使用 JWT 进行用户认证。首先，你需要添加 JWT 配置：

from fastapi_guard import JWTGuard, OAuth2PasswordBearer

guard = JWTGuard(
    secret="your_secret_key",
    algorithms=["HS256"],
    tokenUrl="token",
    OAuth2PasswordBearer=OAuth2PasswordBearer("token"),
)

然后，创建一个端点来生成 JWT：

@app.post("/token")
async def login_for_access_token(form_data: OAuth2PasswordRequestForm = Depends()):
    user_id = authenticate_user(form_data.username, form_data.password)
    access_token = guard.create_access_token(data={"sub": user_id})
    return {"access_token": access_token, "token_type": "bearer"}