FastAPI Users安装与配置完全指南

樊杏蔷

于 2024-09-13 22:31:32 发布

阅读量263

点赞数 2

本文链接：https://blog.csdn.net/gitblog_07613/article/details/142233025

版权

FastAPI Users安装与配置完全指南

fastapi-users Ready-to-use and customizable users management for FastAPI 项目地址: https://gitcode.com/gh_mirrors/fa/fastapi-users

项目基础介绍及编程语言

FastAPI Users 是一个为基于FastAPI构建的应用快速集成用户管理功能的开源库。它强调可扩展性和定制性，使得开发者能够轻松加入用户注册、登录、密码重置、邮箱验证等功能。此项目核心使用 Python 编程语言，并且高度兼容异步编程模式，非常适合现代Web应用开发。

关键技术和框架

FastAPI: 高性能web框架，支持类型注解和异步编程。
Pydantic: 用于数据验证和设置模型。
SQLAlchemy/asyncio: 提供数据库ORM支持，对于同步和异步环境都有适应方案。
MongoDB/Beanie: 作为NoSQL数据库选项，通过Beanie ODM集成。
JWT (JSON Web Tokens): 用于认证的轻量级标准，提供安全的用户身份验证。
OAuth2: 社交账号登录支持，增加用户便利性。

安装和配置步骤

准备工作

确保你的开发环境中已安装以下软件：

Python 3.7 或更高版本
pip, Python的包管理器
可选的虚拟环境工具（如 venv 或 conda），推荐用于隔离项目依赖。

步骤一：创建虚拟环境

首先，创建并激活一个虚拟环境（这里以venv为例）:

python -m venv my-fastapi-env
source my-fastapi-env/bin/activate  # 在Windows上是 `my-fastapi-env\Scripts\activate`

步骤二：安装FastAPI Users

接下来，安装fastapi-users及其依赖:

pip install fastapi-users[all]

这里的 [all] 表示安装所有额外依赖，包括数据库适配器、JWT策略等。

步骤三：配置基础FastAPI应用

创建一个新的Python文件（如 main.py），并引入必要的FastAPI组件以及FastAPIUsers实例：

from fastapi import FastAPI
from fastapi_users import FastAPIUsers
from fastapi_users.authentication import JWTAuthentication
from fastapi_users.db import贝妮尼UserDatabase

# 假定我们已有User模型与数据库适配逻辑
app = FastAPI()

# 假设这是获取数据库连接的函数
async def get_user_db():
    # 实际实现应指向你的数据库连接或ORM操作
    pass

bearer_transport = BearerTransport(tokenUrl="auth/jwt/login")
jwt_strategy = JWTStrategy(secret="your-secret-key", lifetime_seconds=3600)

auth_backend = JWTAuthentication(
    name="jwt",
    transport=bearer_transport,
    get_strategy=jwt_strategy,
)

fastapi_users = FastAPIUsers[YourUserModel, PydanticObjectId](
    get_user_db,
    [auth_backend],
)

@app.on_event("startup")
async def startup():
    # 初始化任何在启动时需要的操作
    pass

@app.get("/")
async def root(current_user: YourUserModel = Depends(fastapi_users.current_user(active=True))):
    return {"message": f"Hello, {current_user.username}!"}

请注意替换YourUserModel, PydanticObjectId和数据库初始化逻辑，这些是根据你的具体应用需求来定制的。