fastapi之自定义路由类

于 2024-08-13 00:06:49 发布
阅读量338 收藏 8
点赞数 18
分类专栏： FastApi python 文章标签： fastapi python 测试
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/liudadaxuexi/article/details/141143732
版权

文章目录

APIRouter的角色

在 FastAPI 中，APIRouter 是一个用于定义和管理一组相关路由的类。它允许将应用的路由模块化，并提供了一种灵活的方式来组织代码。

方法重写的概念

Python 提供了面向对象编程的能力，包括继承和方法重写。通过继承一个类，并重写其方法，可以改变或扩展该类的行为。在自定义路由类中，通过继承 APIRouter 并重写其方法来实现自定义逻辑。

核心方法 api_route

APIRouter 中的 api_route 方法是所有路由注册方法的底层实现，包括 get, post, put, delete 等 HTTP 方法。通过重写 api_route 方法，可以在所有类型的路由注册时应用自定义逻辑。

实现自定义路由类的步骤

继承 APIRouter

首先，通过创建一个新的类继承 APIRouter。这允许在保留 APIRouter 原有功能的基础上，添加自定义的逻辑。

from fastapi import APIRouter

class CustomRouter(APIRouter):
    pass

重写 api_route 方法

重写 api_route方法，可以在每次路由注册时应用自定义逻辑。示例中，选择在没有 tags 参数时，为路由添加一个默认标签。

class CustomRouter(APIRouter):
    def api_route(self, path: str, **kwargs):
        if "tags" not in kwargs:
            kwargs["tags"] = ["default"]
        return super().api_route(path, **kwargs)

参数解释:

  • path: str: 路由路径。
  • kwargs: 其他关键字参数，包括 HTTP 方法、响应模型、标签等。

功能逻辑:

  • 检查 kwargs 中是否包含 tags 参数。
  • 如果没有 tags，则设置一个默认值 ["default"]。
  • 调用父类的 api_route 方法以保留 APIRouter 的其他功能。

实例化并使用自定义路由类

创建 CustomRouter 的实例，并像使用普通 APIRouter 一样使用它来定义路由。

router = CustomRouter()

@router.get("/custom-route/")
def custom_route():
    return {"message": "This is a custom route"}
  • @router.get("/custom-route/"): 定义一个 GET 请求的路由。通过使用 CustomRouter 实例，这个路由会自动应用在 api_route 方法中定义的自定义逻辑。

将自定义路由类挂载到 FastAPI 应用

将自定义的 router 实例挂载到 FastAPI 应用中，和普通 APIRouter 一样：

from fastapi import FastAPI

app = FastAPI()

app.include_router(router)

完整示例代码

import os
from fastapi import FastAPI, APIRouter
import uvicorn


# 自定义路由类
class CustomRouter(APIRouter):
    def api_route(self, path: str, **kwargs):
        # 如果未定义tags，则设置默认标签
        kwargs["tags"] = ["default"]
        return super().api_route(path, **kwargs)


# 创建自定义路由实例
router = CustomRouter()


# 定义一个路由
@router.get("/custom-route/")
def custom_route():
    return {"message": "This is a custom route"}


# 创建FastAPI应用并挂载自定义路由
app = FastAPI()
app.include_router(router)

if __name__ == "__main__":
    uvicorn.run(
        f"{os.path.basename(__file__).split('.')[0]}:app",
        host="127.0.0.1",
        port=8000,
        reload=True,
    )

测试

在这里插入图片描述

在这里插入图片描述

全面示例

自定义路由_全面.py

import os
from fastapi import FastAPI, APIRouter, Depends, HTTPException, Request
from fastapi.responses import JSONResponse
from fastapi.security import HTTPBasic, HTTPBasicCredentials
import logging
import uvicorn

# 设置基础依赖和中间件
security = HTTPBasic()


# 自定义的凭证验证函数
def verify_credentials(credentials: HTTPBasicCredentials = Depends(security)):
    correct_username = "admin"
    correct_password = "password"
    if not (
        credentials.username == correct_username
        and credentials.password == correct_password
    ):
        # 如果用户名或密码不匹配，则抛出401异常
        raise HTTPException(status_code=401, detail="Invalid credentials")
    return credentials.username


# 日志记录函数
async def log_request(request: Request):
    logging.info(f"Handling request: {request.method} {request.url}")


# 自定义路由类
class CustomRouter(APIRouter):
    def api_route(self, path: str, **kwargs):

        if not kwargs.get("tags"):  # 检查是否指定了标签
            kwargs["tags"] = ["default"]  # 如果没有指定标签，设置默认标签为 "default"

        if not kwargs.get("dependencies"):  # 检查是否指定了依赖
            kwargs["dependencies"] = [
                Depends(verify_credentials)
            ]  # 如果没有指定依赖，添加默认的凭证验证依赖
        else:
            kwargs["dependencies"].append(
                Depends(verify_credentials)
            )  # 如果已有依赖，追加凭证验证依赖

        # 调用父类的 `api_route` 方法来注册路由
        return super().api_route(path, **kwargs)


# 创建 FastAPI 应用
app = FastAPI()


# 定义统一的异常处理
@app.exception_handler(HTTPException)
async def custom_http_exception_handler(request: Request, exc: HTTPException):
    return JSONResponse(
        status_code=exc.status_code,
        content={"message": f"Oops! Something went wrong: {exc.detail}"},
    )


# 使用自定义路由类定义路由
router = CustomRouter()


@router.get("/secure-route/")
async def secure_route(username: str = Depends(verify_credentials)):
    return {"message": f"Welcome {username}!"}


@router.post("/log-route/")
async def log_route(data: dict):
    return {"received": data}


@router.get("/custom-route/")
async def custom_route():
    return {"message": "This is a custom route with default tag and security"}


# 挂载自定义路由
app.include_router(router)

# 运行应用
if __name__ == "__main__":
    uvicorn.run(
        f"{os.path.basename(__file__).split('.')[0]}:app",  # 动态获取当前文件名来设置应用路径
        host="127.0.0.1",  # 设置主机为本地
        port=8000,  # 设置端口为8000
        reload=True,  # 启用自动重载（开发模式下非常有用）
    )

解释

  • 权限验证: 在 api_route 方法中，为每个路由自动添加 verify_credentials 依赖，确保所有路由都需要权限验证。

  • 日志记录: 在每个请求处理之前，调用 log_request 记录请求的基本信息。

  • 默认标签: 如果用户在定义路由时未指定 tags，系统会自动为其添加一个默认标签 ["default"]。

  • 统一异常处理: 在 app 中定义了一个统一的异常处理函数，处理 HTTPException。

测试

首先安装

pip install fastapi httpx pytest

之后

from fastapi.testclient import TestClient
from 自定义路由_全面 import app  # 导入要测试的 FastAPI 应用

# 创建测试客户端
client = TestClient(app)

# 测试 secure-route 路由，使用正确的凭据
def test_secure_route_with_correct_credentials():
    # 使用正确的用户名和密码发起GET请求
    response = client.get("/secure-route/", auth=("admin", "password"))
    # 断言响应的状态码应为200，表示请求成功
    assert response.status_code == 200
    # 断言响应的JSON内容应为欢迎信息
    assert response.json() == {"message": "Welcome admin!"}

# 测试 secure-route 路由，使用错误的凭据
def test_secure_route_with_wrong_credentials():
    # 使用错误的用户名和密码发起GET请求
    response = client.get("/secure-route/", auth=("wronguser", "wrongpass"))
    # 断言响应的状态码应为401，表示未经授权
    assert response.status_code == 401
    # 断言响应的JSON内容应为错误提示信息
    assert response.json() == {
        "message": "Oops! Something went wrong: Invalid credentials"
    }

# 测试 log-route 路由
def test_log_route():
    # 使用正确的凭据和JSON数据发起POST请求
    response = client.post(
        "/log-route/", json={"test": "data"}, auth=("admin", "password")
    )
    # 断言响应的状态码应为200，表示请求成功
    assert response.status_code == 200
    # 断言响应的JSON内容应为接收到的数据
    assert response.json() == {"received": {"test": "data"}}

# 测试 custom-route 路由
def test_custom_route():
    # 使用正确的凭据发起GET请求
    response = client.get("/custom-route/", auth=("admin", "password"))
    # 断言响应的状态码应为200，表示请求成功
    assert response.status_code == 200
    # 断言响应的JSON内容应为指定的自定义消息
    assert response.json() == {
        "message": "This is a custom route with default tag and security"
    }

# 运行所有测试
if __name__ == "__main__":
    # 逐个调用测试函数
    test_secure_route_with_correct_credentials()
    test_secure_route_with_wrong_credentials()
    test_log_route()
    test_custom_route()
    # 所有测试通过时，打印提示信息
    print("All tests passed!")

解释

  1. client = TestClient(app):
  • 创建一个 TestClient 实例，它模拟一个客户端，用于发送请求到定义的 FastAPI 应用。这使得能够在不启动实际服务器的情况下测试 API。
  1. test_secure_route_with_correct_credentials 测试函数:
  • 该函数测试 /secure-route/ 路由，并使用正确的用户名和密码进行身份验证。
  • 它检查服务器是否返回 200 状态码，并且返回的 JSON 响应包含欢迎信息。
  1. test_secure_route_with_wrong_credentials 测试函数:
  • 该函数测试 /secure-route/ 路由，并使用错误的凭据进行身份验证。
  • 它检查服务器是否返回 401 状态码，并且返回的 JSON 响应包含错误消息。
  1. test_log_route 测试函数:
  • 该函数测试 /log-route/ 路由，并发送一个 JSON 数据的 POST 请求。
  • 它检查服务器是否返回 200 状态码，并且返回的 JSON 响应包含发送的数据。
  1. test_custom_route 测试函数:
  • 该函数测试 /custom-route/ 路由，确保它使用正确的凭据时返回预期的自定义消息。
  • 它检查服务器是否返回 200 状态码，并且返回的 JSON 响应符合预期。
  1. if __name__ == "__main__":
  • 这个部分的代码允许直接运行测试脚本。当运行这个脚本时，它会依次调用所有的测试函数并输出测试结果。

结果

在这里插入图片描述

总结

本指南详细介绍了如何在 FastAPI 中自定义 APIRouter 类，以实现统一的路由配置和逻辑扩展。通过自定义 APIRouter，开发者可以在保留原有功能的基础上，添加自定义的逻辑，如自动添加标签、统一的权限验证、日志记录等。具体实现包括继承 APIRouter 并重写其核心方法 api_route，在路由注册时应用自定义逻辑。最终，通过实例化自定义的路由类并将其挂载到 FastAPI 应用中，实现了统一管理路由的行为。
此外，本指南还提供了一个完整的示例代码，展示了如何应用这些自定义逻辑，并附上了详细的测试代码。通过 TestClient 模拟客户端请求，编写了一系列测试函数，确保应用在不同情况下的正确性。这样不仅提升了代码的模块化和可维护性，还保证了应用在不同场景下的一致性和稳定性。

trust Tomorrow
关注
  • 18
    点赞
  • 踩
  • 8
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
专栏目录
fastapi自定义中间件
ithongchou的博客
06-28 473
接收来自客户端的Request请求；# 将Request请求传回原路由。
Fastapi自定义中间件动态处理多数据库连接
gewenjun13671的博客
07-21 2056
fastapi自定义中间件实现多数据库动态连接
Python FastAPI系列：自定义FastAPI middleware中间件
夜如水.think
10-24 4439
​​在一些情况下，我们需要对整个FastAPI应用的全部或部分路由执行一些通用的功能，例如身份验证、日志记录、错误处理等，我们可以通过自定义FastAPI middleware中间件来完成。
fastapi中实现多个路由请求
穆雄雄的博客
05-25 676
最近在写机器人相关的接口，顺手学了学python，发现这是个好东西，写代码效率比java要高很多，比如写个词云呀，写个回调呀，或者写个数据分析等等，都很方便。今天，顺便在此记录一下，在使用fastapi的时候，创建多个文件，多个路由的问题。
FastAPI入门教程 路由参数（非常详细）零基础入门到精通，收藏这一篇就够了
Python_paipai的博客
06-09 1235
• Pydantic模型Pydantic模型用于更复杂的请求处理和验证。
【大模型应用开发-FastAPI框架】(六)FastAPI自定义路由文件夹
04-13 429
本文目的是为创建三个不同模块：common、news、user然后在main.py中设置不同的入口，根据url在不同的路由文件夹中进行响应。本文目的是为创建三个不同模块：common、news、user然后在main.py中设置不同的入口，根据url在不同的路由文件夹中进行响应。
fastapi教程（五）：中间件
dangfulin的博客
07-29 846
限流中间件：限制每个IP在特定时间窗口内的请求次数。响应时间模拟中间件：、为每个请求添加随机延迟。用于测试前端应用对不同响应时间的处理能力。可以模拟真实世界的网络延迟，帮助发现潜在的超时问题。请求ID中间件：为每个请求分配一个唯一的ID。方便跟踪和调试请求，特别是在分布式系统中。响应内容修改中间件：修改JSON响应中的特定内容。可以用于统一处理某些响应，如敏感信息脱敏。日志中间件：记录每个请求和响应的详细信息，对于调试和监控非常有用。错误处理中间件：全局捕获异常并自定义错误响应。
FastApi开发教程
平时不搬砖的博客
03-21 1114
FastAPI是一个用于构建API的现代、快速（高性能）的web框架。它基于Python 3.6+，并利用了Python的类型提示。高性能：FastAPI与NodeJS和Go具有可比的出色性能，这主要归功于它建立在Starlette和Pydantic之上，并利用异步编程。高效编码：它能够提高功能开发速度约200%至300%，同时减少约40%的人为（开发者）导致的错误。智能与易用：FastAPI提供了极佳的编辑器支持，处处皆可自动补全，减少了调试时间。此外，它设计的易于使用和学习，使得阅读文档的时间更短。
FastAPI框架学习笔记(快速入门FastAPI框架)
Miracle8070
10-29 5005
今天整理一篇后端框架的笔记， fastapi框架是比较主流的后端异步web框架，关键是python语言可以写，正好公司最近安排了一些后端服务的活， 所以就看了一个fastapi框架的入门课程(链接在底部)，完成任务，这次想把学习的笔记整理下，方便以后回看回练。
fastapi-users:即用型和可自定义的FastAPI用户管理
04-28
即用型和可自定义的FastAPI用户管理 说明文件： 源代码： 快速向您的项目添加注册和身份验证系统。 FastAPI用户旨在尽可能地自定义和适应。 特征 可扩展的基本用户模型 即用型注册，登录，重设密码并验证电子...
fastapi静态资源
05-31
2. **使用`StaticFiles`**：FastAPI提供了一个内置的`StaticFiles`类，可以用来方便地托管和提供静态文件。你可以像这样设置： ```python from fastapi import FastAPI from fastapi.staticfiles import ...
基于FastAPI Vue的 CMDB管理系统
01-08
1. `api`：FastAPI的路由和模型定义，负责处理后端逻辑。 2. `models`：数据库模型，描述了数据表的结构。 3. `schemas`：OpenAPI schema对象，用于定义请求和响应的数据格式。 4. `main.py`或`app.py`：FastAPI应用...
fastapi：FastAPI教程
01-28
2. **异步支持**：FastAPI构建在ASGI（Asynchronous Server Gateway Interface）之上，允许开发者编写异步代码，提高服务器处理请求的效率，特别适合处理I/O密集型任务。 3. **强大的依赖注入**：FastAPI的依赖注入...
cjh_fastapi_base.zip
03-24
1. **路由和路径操作**：理解FastAPI的路径操作函数和路径参数，例如使用`@app.get("/")`定义GET请求。 2. **请求和响应**：了解`Request`对象和`Response`对象，以及如何处理HTTP请求和构建响应。 3. **Pydantic...
FastAPI入门
m0_70618214的博客
08-13 1307
什么是 FastAPI 呢？ FastAPI 是 Python 的一个框架，如果要类比的话，那就是： Nodejs 和 Nestjs Java 和 Spring Php 和 ThinkPhp
大模型微调工具-torchtune
weixin_40777649的博客
08-08 893
1.定义2.安装3. 案例。
NVIDIA-CUDA
qq_41081716的博客
08-08 424
CUDA 是一种强大的并行计算平台，它极大地扩展了 GPU 的用途，使其不仅仅局限于图形处理。通过利用 CUDA，开发人员可以编写高效、高性能的并行应用程序，这些应用程序可以用于各种计算密集型任务。如果您正在从事高性能计算或需要加速计算任务的工作，CUDA 是一个非常有用的工具。
Falsk测试与部署（第九阶段）
最新发布
蜡笔小新星的博客
08-09 626
在本章节中，我们学习了如何使用unittest和pytest进行单元和集成测试，以及如何配置Flask应用，使用WSGI服务器部署，容器化Flask应用并将其部署到各种云服务平台。通过这些步骤，你可以确保你的Flask应用在生产环境中的稳定性和可靠性。希望这些知识能够帮助你在实际项目中更好地实现测试和部署。
fastapi_cache
03-11
FastAPI-Cache是一个基于FastAPI的缓存扩展，它提供了简单而强大的缓存功能，可以帮助开发者轻松地添加缓存支持到FastAPI应用程序中。 FastAPI-Cache的主要特点包括： 1. 简单易用：FastAPI-Cache提供了简洁的API，使得添加缓存变得非常容易。只需使用装饰器将需要缓存的路由函数标记为缓存即可。 2. 多种缓存后端支持：FastAPI-Cache支持多种缓存后端，包括内存、Redis、Memcached等。你可以根据自己的需求选择适合的缓存后端。 3. 自定义缓存策略：FastAPI-Cache允许你自定义缓存策略，包括缓存过期时间、缓存键的生成方式等。这样你可以根据具体的业务需求来配置缓存策略。 4. 异步支持：FastAPI-Cache完全支持异步操作，可以与FastAPI的异步特性完美结合，提供高性能的缓存功能。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

trust Tomorrow

感谢支持！

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值