Python fastapi-jwt-auth 模块：使用教程

python库 › web开发
, , ,

Python fastapi-jwt-auth 模块使用教程

fastapi-jwt-auth 模块是一个方便易用的 JWT（JSON Web Token）认证工具，专为 FastAPI 框架设计。它能够帮助开发者在构建 API 时实现用户身份认证和授权控制。此模块可以与 Python 3.6 及以上版本很好地兼容，让开发者容易集成 JWT 功能，以增强 Web 应用的安全性。

应用场景

fastapi-jwt-auth 模块的主要用途在于对 Web 应用中的用户进行安全认证。它适用于需要用户注册和登录的场景，在这样的场合中，保护用户数据和请求安全是至关重要的。以下是一些常见的应用方向：

  1. RESTful API 的用户身份验证。
  2. 需要保护的 Web 应用，限制用户访问某些资源。
  3. 单页应用（SPA）中的用户状态管理。

安装说明

fastapi-jwt-auth 并不是 Python 的默认模块，需要进行安装。你可以通过 pip 进行安装：

1
pip install fastapi-jwt-auth

安装后，您可以在 FastAPI 项目中直接导入并使用该模块。

用法举例

示例 1：基本的用户注册与登录

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
from fastapi import FastAPI, Depends
from fastapi.security import OAuth2PasswordBearer, OAuth2PasswordRequestForm
from fastapi_jwt_auth import JWTAuth

app = FastAPI()

# 配置JWT
jwt_auth = JWTAuth(secret='your_secret_key', lifetime_seconds=3600)

# 创建用户登录的表单
oauth2_scheme = OAuth2PasswordBearer(tokenUrl="token")

# 模拟用户数据
fake_users_db = {
    "johndoe": {
        "username": "johndoe",
        "full_name": "John Doe",
        "email": "johndoe@example.com",
        "hashed_password": "fakehashedpassword",
        "disabled": False,
    }
}

# 用户登录接口
@app.post("/token")
async def login(form: OAuth2PasswordRequestForm = Depends()):
    user = fake_users_db.get(form.username)
    if not user or user['hashed_password'] != "fakehashedpassword":  # 验证用户
        return {"error": "Invalid credentials"}
    access_token = jwt_auth.create_access_token(subject=user['username'])  # 生成访问令牌
    return {"access_token": access_token, "token_type": "bearer"}

在这个例子中，我们创建了一个用户登录接口，用户成功登录后会返回一个 JWT 令牌，方便后续请求进行权限验证。

示例 2：保护受限资源

1
2
3
4
5
6
7
8
9
from fastapi import HTTPException, Security

# 受保护的API示例
@app.get("/users/me")
async def read_users_me(token: str = Depends(oauth2_scheme)):
    payload = jwt_auth.get_jwt_subject(token)  # 解码JWT
    if not payload:
        raise HTTPException(status_code=401, detail="Invalid JWT token")
    return {"username": payload}  # 返回当前用户信息

在这里，我们通过依赖注入获取 JWT 令牌，解码后可以保护用户资源，确保只有持有有效令牌的用户才能访问。

示例 3：登出功能

1
2
3
4
5
6
7
@app.post("/logout")
async def logout(token: str = Depends(oauth2_scheme)):
    try:
        jwt_auth.blacklist(token)  # 将令牌加入黑名单
        return {"message": "Successfully logged out"}
    except:
        raise HTTPException(status_code=401, detail="Invalid token")

此示例中，我们定义了一个登出接口，通过将令牌加入黑名单来实现安全退出功能。

软件和库版本不断更新

由于软件和库版本不断更新，如果本文档不再适用或有误，请留言或联系我进行更新。让我们一起营造良好的学习氛围。感谢您的支持！ - Travis Tang

强烈建议大家关注本人的博客全糖冲击博客，因为我的博客包含了所有 Python 标准库使用教程，内容全面且更新及时，方便大家进行查询和学习。通过关注我的博客，您将获得 practical insights 和 detailed examples，提高您的编程能力，让您在开发中更得心应手。感谢您的支持与关注！