FastAPI-Auth使用指南

FastAPI-Auth使用指南

fastapi-auth Auth for use with FastAPI 项目地址: https://gitcode.com/gh_mirrors/fa/fastapi-auth

项目介绍

FastAPI-Auth 是一个专为 FastAPI 设计的认证插件，它支持OAuth2密码流程，并利用JWT（JSON Web Tokens）来处理访问和刷新令牌。该库强调了类型安全的重要性，即便是对于自定义用户模型（既支持ORM也支持Pydantic模型）。其完整的类型注解确保了在实现复杂身份验证逻辑时保持代码的清晰和健壮性。通过提供一系列预构建的路由器和设置，它简化了将认证功能集成到现有FastAPI应用程序的过程。

项目快速启动

安装依赖

首先，你需要安装fastapi-auth以及它的开发依赖项。通常，这可以通过以下命令完成：

pip install fastapi-auth

示例应用

以下是快速启动示例，展示了如何配置并使用此库来添加认证功能到你的FastAPI应用中。

from typing import Optional
import sqlalchemy as sa
from fastapi import FastAPI
from pydantic import EmailStr
from fastapi_auth.auth_app import BaseAuthRouterBuilder
from fastapi_auth.auth_settings import get_auth_settings
# 假定其他必需的模型和配置已正确定义

app = FastAPI()

class ExtraUserAttributes(APIModel):
    email: Optional[EmailStr]

# 自定义用户模型与FastAPI-Auth模型结合
# 注意：这里的类定义应根据实际数据库模式进行调整

# 初始化路由构建器
router_builder = BaseAuthRouterBuilder(
    get_auth_settings(),
    # 使用自定义的用户模型和其他相关类型
)

# 将认证路由添加到FastAPI应用
router_builder.include_auth(app)
router_builder.add_expired_token_cleanup(app)

print(list(app.openapi()["paths"].keys()))

运行这个脚本后，您的FastAPI应用将拥有认证相关的端点，如登录、注册、令牌管理等，并可通过/docs访问交互式文档。

应用案例和最佳实践

最佳实践一：定制化用户模型

FastAPI-Auth允许高度定制用户模型，包括但不限于扩展属性。这通过继承基础模型并添加额外字段来实现，从而保留类型安全的同时满足特定业务需求。

最佳实践二：环境变量配置

为了增强安全性，建议使用环境变量来存储敏感信息，比如数据库连接字符串或JWT密钥。这可以利用FastAPI的环境变量加载机制，确保这些值不被提交到版本控制中。

最佳实践三：测试集成

在开发过程中，确保对认证流程进行全面测试。利用FastAPI内置的测试客户端和mock用户数据来模拟认证情景，验证每个端点的行为是否符合预期。

典型生态项目

虽然直接在文档中没有列出典型的生态项目与FastAPI-Auth搭配使用的实例，但在FastAPI的生态系统中，常见的搭配可能包括使用uvicorn作为ASGI服务器，结合SQLAlchemy进行数据库操作，以及可能与Swagger UI或ReDoc一起用于API文档的可视化展示，确保开发者和测试人员可以直观地理解认证接口的工作方式。

以上指导提供了快速上手FastAPI-Auth的路径，但深入应用还需参考其GitHub仓库中的详细文档和示例代码。

fastapi-auth Auth for use with FastAPI 项目地址: https://gitcode.com/gh_mirrors/fa/fastapi-auth