FastAPI Users 使用指南

FastAPI Users 使用指南

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

项目目录结构及介绍

FastAPI Users 是一个构建在 FastAPI 框架之上的用户管理库，提供了用户注册、认证等核心功能。以下是一个典型的 fastapi-users 项目结构示例：

fastapi_app/
├── app/
│   ├── main.py           # 主入口文件，用于初始化 FastAPI 应用
│   ├── models.py         # 定义 User 模型以及数据库模型（如 UserDB）
│   ├── dependencies.py   # 包含 FastAPI Users 相关依赖项，如用户数据库操作
│   └── routers/          # 路由模块，存放认证、注册等路由处理逻辑
│       ├── auth.py
│       └── users.py
├── requirements.txt      # 项目所需的第三方库列表
├── config.py             # 配置文件，定义数据库连接、JWT密钥等设置
├── database.db            # 如果使用SQLite作为数据库，这是数据库文件
└── README.md              # 项目说明文档

• main.py：应用程序的主要启动脚本，负责创建 FastAPI 实例并集成 FastAPI Users。
• models.py：包含用户数据的模型定义，包括用户基础模型和数据库模型。
• dependencies.py：提供依赖注入相关函数，比如用户数据库的访问对象。
• routers/auth.py 和 routers/users.py: 分别实现认证（登录、注销）和其他用户相关的API。
• config.py：存储应用的配置信息，包括数据库URL、JWT密钥等敏感数据。
• requirements.txt：列出项目依赖的Python包。

项目的启动文件介绍

main.py 是项目的入口点，其关键部分通常包含以下步骤：

from fastapi import FastAPI
from fastapi_users import FastAPIUsers
from .models import User, UserCreate, UserUpdate
from .database import get_user_db

app = FastAPI()

# 初始化 FastAPI Users
fastapi_users = FastAPIUsers[User, int](
    get_user_db,
    [auth_backend],
)

@app.on_event("startup")
async def startup():
    await database.connect()

@app.on_event("shutdown")
async def shutdown():
    await database.disconnect()

app.include_router(
    fastapi_users.get_auth_router(auth_backend), 
    prefix="/auth", 
    tags=["auth"],
)
...

这里，get_user_db 函数应该从dependencies.py导入，用来创建用户数据库的实例。auth_backend代表认证机制（例如JWT或基本认证）。

项目的配置文件介绍

配置通常位于单独的文件中，如 config.py，以保持代码的整洁和可维护性。一个基本的配置文件可能看起来像这样：

DATABASE_URL = "sqlite:///./database.db"
SECRET = "your-secret-key-here"
ALGORITHM = "HS256"
ACCESS_TOKEN_EXPIRE_MINUTES = 30

USER_MODELS = {"user_model": User, "create_schema_type": UserCreate, "update_schema_type": UserUpdate}

• DATABASE_URL：指定数据库的连接字符串，对于SQLite，可以是相对于运行脚本的位置。
• SECRET：用于加密JWT令牌的密钥，必须保密。
• ALGORITHM：JWT算法类型，此处为HMAC SHA256。
• ACCESS_TOKEN_EXPIRE_MINUTES：访问令牌的有效期。
• USER_MODELS：定义用户模型和对应的创建、更新模式，确保FastAPI Users能够识别你的用户模型。

通过以上结构和配置，开发者可以快速地将用户认证和管理功能集成到自己的FastAPI应用中。

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