FastAPI-Login 使用教程

项目介绍

FastAPI-Login 是一个为 FastAPI 框架提供的用户认证库，旨在简化并加速开发过程中的用户认证部分。它提供了类似于 Flask-Login 的功能，支持在请求头或 cookie 中使用 token，并且可以作为中间件使用，创建自定义依赖项。此外，它还支持 OAuth2 范围和 OpenAPI 文档生成。

项目快速启动

安装

首先，你需要安装 FastAPI-Login 库。你可以使用 pip 进行安装：

pip install fastapi-login

初始化 FastAPI 应用

接下来，你需要初始化你的 FastAPI 应用，并设置一个密钥：

from fastapi import FastAPI

SECRET = 'your-secret-key'
app = FastAPI()

设置 LoginManager

然后，你需要导入并设置 LoginManager，它将处理 JWT 的编码和解码：

from fastapi_login import LoginManager

manager = LoginManager(SECRET, token_url='/auth/token')

模拟用户数据库

为了示例，我们将使用一个字典来表示我们的用户数据库。在你的实际应用中，这可以是一个真正的数据库，如 SQLite 或 PostgreSQL：

fake_db = {
    '[e-mail]': {'password': 'secret'}
}

创建访问令牌

最后，你可以创建一个访问令牌并设置 cookie：

@app.post('/auth/token')
def login(response):
    email = '[e-mail]'
    password = 'secret'
    if fake_db[email]['password'] == password:
        access_token = manager.create_access_token(
            data=dict(sub=email)
        )
        manager.set_cookie(response, access_token)
        return response

应用案例和最佳实践

应用案例

FastAPI-Login 可以用于任何需要用户认证的 FastAPI 应用。例如，你可以用它来保护 API 端点，确保只有经过认证的用户才能访问敏感数据。

最佳实践

1. 安全存储密钥：不要将密钥硬编码在代码中，而是使用环境变量来存储。
2. 使用 HTTPS：确保你的应用在生产环境中使用 HTTPS，以保护传输中的数据。
3. 定期更新密钥：定期更换密钥可以增加安全性。

典型生态项目

FastAPI-Login 可以与其他 FastAPI 生态项目结合使用，例如：

• FastAPI-Users：一个用于管理用户注册和认证的库。
• FastAPI-SQLAlchemy：一个用于与 SQLAlchemy 集成的库，方便数据库操作。
• FastAPI-Scheduler：一个用于任务调度的库。

通过结合这些库，你可以构建一个功能丰富且安全的 FastAPI 应用。