”工欲善其事,必先利其器。“—孔子《论语.录灵公》
首页 > 编程 > 如何为特定 FastAPI 路由自定义错误响应?

如何为特定 FastAPI 路由自定义错误响应?

发布于2024-12-21
浏览:780

How to Customize Error Responses for Specific FastAPI Routes?

如何在 FastAPI 中自定义特定路由的错误响应

在 FastAPI 中,引发 RequestValidationError 允许您发送自定义错误响应。这对于需要满足特定条件的端点非常有用,例如必需的标头。

选项 1:覆盖默认异常处理程序

此选项允许您覆盖默认异常处理程序RequestValidationError,允许您自定义错误响应。

from fastapi import FastAPI, Request, Header, status
from fastapi.exceptions import RequestValidationError
from fastapi.responses import JSONResponse

app = FastAPI()
routes_with_custom_exception = ['/']

@app.exception_handler(RequestValidationError)
async def validation_exception_handler(request: Request, exc: RequestValidationError):
    if request.url.path in routes_with_custom_exception:
        return JSONResponse(content={'401': 'Unauthorized'}, status_code=401)
    
    return JSONResponse(
        status_code=status.HTTP_422_UNPROCESSABLE_ENTITY,
        content=jsonable_encoder({'detail': exc.errors(), 'body': exc.body}),
    )

选项 2:使用子应用程序

创建子应用程序允许您创建具有自己的异常处理程序的单独 API 实例。这允许您专门为子应用程序自定义错误处理。

from fastapi import FastAPI
from fastapi.exceptions import RequestValidationError
from fastapi.responses import JSONResponse

app = FastAPI()
subapi = FastAPI()

@subapi.exception_handler(RequestValidationError)
async def validation_exception_handler(exc: RequestValidationError):
    return JSONResponse(content={'401': 'Unauthorized'}, status_code=401)
    
@subapi.get('/')
async def subapi_route(some_custom_header: str = Header(...)):
    return {'some-custom-header': some_custom_header}

app.mount('/sub', subapi)

选项 3:使用自定义 APIRoute 类

此方法允许您使用自定义 APIRoute 类更改特定路由的行为。

from fastapi import FastAPI, APIRouter, Response, Request, Header, HTTPException
from fastapi.exceptions import RequestValidationError

class ValidationErrorHandlingRoute(APIRoute):
    def get_route_handler(self) -> Callable:
        original_route_handler = super().get_route_handler()

        async def custom_route_handler(request: Request) -> Response:
            try:
                return await original_route_handler(request)
            except RequestValidationError as e:
                raise HTTPException(status_code=401, detail='401 Unauthorized')

        return custom_route_handler

app = FastAPI()
router = APIRouter(route_class=ValidationErrorHandlingRoute)

@router.get('/custom')
async def custom_route(some_custom_header: str = Header(...)):
    return {'some-custom-header': some_custom_header}

app.include_router(router)

您应该使用哪个选项?

当您只需要为特定路由自定义错误响应时,选项 1 很容易实现。当您想要对 API 的子区域进行更多控制(例如应用不同的安全策略或异常处理)时,选项 2 适合。选项 3 使您可以更好地控制各个路线,并且对于处理路线内的特定情况很有用。

最新教程 更多>
  • 如何在 CSS 媒体查询中使用“OR”逻辑组合多个条件?
    如何在 CSS 媒体查询中使用“OR”逻辑组合多个条件?
    使用 OR 逻辑组合 CSS 媒体查询中的多个条件在 CSS 媒体查询中,使用“OR”逻辑指定多个条件可能很有用用于定位具有不同屏幕尺寸或方面的设备。虽然问题中提供的代码不正确,但有一个简单的方法可以实现所需的结果。要使用“OR”逻辑指定多个条件,请用逗号分隔:@media screen and (...
    编程 发布于2024-12-21
  • 为什么我的 Go 代码中出现“已导入但未使用”错误?如何修复该错误?
    为什么我的 Go 代码中出现“已导入但未使用”错误?如何修复该错误?
    Go 中错误:“已导入且未使用”Go 中导入包时,出现“已导入且未使用”错误如果导入的包未在当前文件中使用。在您的情况下,您导入了“./api”包。编译器检测到您尚未在代码中使用此包。要解决此错误,您需要实际利用包中的某些内容。您已经提到您在 main 函数中使用 api 包,但您的代码正在使用名为...
    编程 发布于2024-12-21
  • 如何在 Python 列表推导式中使用 if/else 逻辑?
    如何在 Python 列表推导式中使用 if/else 逻辑?
    使用 if/else 进行列表推导式:语法和用法在 Python 中使用列表推导式时,会遇到合并 if/else 逻辑的情况处理条件操作。本文介绍了此类场景的正确语法。一个常见任务是根据源序列创建一个列表,并使用以下包含 if/else 结构的 for 循环:results = [] for x i...
    编程 发布于2024-12-21
  • 如何使用 JavaScript 转义 JSON 字符串中的换行符?
    如何使用 JavaScript 转义 JSON 字符串中的换行符?
    JavaScript 中使用换行符转义 JSON 字符串在 JavaScript 中,构造 JSON 字符串需要转义特殊字符,包括换行符。为此,请按照下列步骤操作:1。字符串化 JSON 对象:使用 JSON.stringify() 将 JSON 对象转换为字符串。2.转义换行符:利用 .repla...
    编程 发布于2024-12-21
  • 大批
    大批
    方法是可以在对象上调用的 fns 数组是对象,因此它们在 JS 中也有方法。 slice(begin):将数组的一部分提取到新数组中,而不改变原始数组。 let arr = ['a','b','c','d','e']; // Usecase: Extract till index p...
    编程 发布于2024-12-21
  • 在 Go 中使用 WebSocket 进行实时通信
    在 Go 中使用 WebSocket 进行实时通信
    构建需要实时更新的应用程序(例如聊天应用程序、实时通知或协作工具)需要比传统 HTTP 更快、更具交互性的通信方法。这就是 WebSockets 发挥作用的地方!今天,我们将探讨如何在 Go 中使用 WebSocket,以便您可以向应用程序添加实时功能。 在这篇文章中,我们将介绍: WebSocke...
    编程 发布于2024-12-21
  • 为什么 SimpleDateFormat 错误地解析“YYYY-MM-dd HH:mm”?
    为什么 SimpleDateFormat 错误地解析“YYYY-MM-dd HH:mm”?
    SimpleDateFormat 错误地解析“YYYY-MM-dd HH:mm”尝试解析格式为“YYYY-MM”的字符串时-dd HH:mm" 到日期,一些开发人员遇到意外的日期结果。当使用 SimpleDateFormat 类并将 lenient 设置设置为 false 时,会发生这种情...
    编程 发布于2024-12-21
  • HTML 格式标签
    HTML 格式标签
    HTML 格式化元素 **HTML Formatting is a process of formatting text for better look and feel. HTML provides us ability to format text without us...
    编程 发布于2024-12-21
  • 如何在Python中高效计算列表的平均值?
    如何在Python中高效计算列表的平均值?
    在Python中计算列表的平均值确定列表的算术平均值或平均值对于统计分析至关重要。在 Python 中,有多种方法可用于此操作。下面是对每种方法的详细探索:Python >= 3.8:statistics.fmean统计模块提供了浮点数的数值稳定性,确保准确的结果。这是Python 3.8及更高版本...
    编程 发布于2024-12-21
  • 如何使用 MySQL 查找今天生日的用户?
    如何使用 MySQL 查找今天生日的用户?
    如何使用 MySQL 识别今天生日的用户使用 MySQL 确定今天是否是用户的生日涉及查找生日匹配的所有行今天的日期。这可以通过一个简单的 MySQL 查询来实现,该查询将存储为 UNIX 时间戳的生日与今天的日期进行比较。以下 SQL 查询将获取今天有生日的所有用户: FROM USERS ...
    编程 发布于2024-12-21
  • 如何设计与标准库正确集成的自定义 STL 容器?
    如何设计与标准库正确集成的自定义 STL 容器?
    编写自定义 STL 容器的指南设计符合 STL 约定的新容器时,遵循某些指南至关重要以确保其正确行为并与 STL 库集成。迭代器接口:定义一个具有适当iterator_category标记的迭代器类,例如input_iterator_tag、output_iterator_tag、forward_i...
    编程 发布于2024-12-21
  • 为什么 REST API 使用不同的 HTTP 方法(PUT、DELETE、POST、GET)?
    为什么 REST API 使用不同的 HTTP 方法(PUT、DELETE、POST、GET)?
    REST API:HTTP 方法(PUT、DELETE、POST、GET)的重要性在 RESTful API 领域,一个基本的问题出现了:为什么要使用多种 HTTP 请求类型,例如 PUT、DELETE、POST 和 GET?重要的是要了解 REST 的目的不仅仅是使用最简单的方法访问数据。REST...
    编程 发布于2024-12-21
  • 为什么我的移动媒体查询无法在移动设备上运行?
    为什么我的移动媒体查询无法在移动设备上运行?
    移动媒体查询在移动设备上不起作用:故障排除提示许多开发人员面临移动设备上 CSS3 媒体查询无响应的问题。如果您遇到此问题,让我们根据您的查询探索潜在的解决方案:在您的样式表中,您正在使用移动设备的媒体查询,但在实际查看时它们似乎不起作用手机。相反,会显示默认 CSS。解决方案:验证媒体查询语法: ...
    编程 发布于2024-12-21
  • 为什么在 C++ 中使用 `` 时,`printf` 在 `std::printf` 和 `printf` 中都可以工作?
    为什么在 C++ 中使用 `` 时,`printf` 在 `std::printf` 和 `printf` 中都可以工作?
    cstdio Stdio.h 命名空间在 的 C 参考文档中,它声称所有库元素都驻留在 std 命名空间内。然而,实验表明 std::printf 和 printf 函数调用都可以工作。这是否表明 C 头文件将符号名称导入到 std 和全局命名空间中?答案包括 将符号名称导入到 std 命名空间...
    编程 发布于2024-12-21
  • Go 中下划线导入的目的是什么?
    Go 中下划线导入的目的是什么?
    理解下划线导入语句在 Go 编程世界中,导入语句前面的下划线字符 ( _ ) 具有特定的含义。让我们探讨一下它的含义和用法。下划线导入的目的导入语句中的下划线 (_ ) 表示导入该包只是为了其副作用。它不会从包中导入任何函数、方法或变量。Go 包中的副作用一些 Go 包具有初始化函数(通常名为 in...
    编程 发布于2024-12-21

免责声明: 提供的所有资源部分来自互联网,如果有侵犯您的版权或其他权益,请说明详细缘由并提供版权或权益证明然后发到邮箱:[email protected] 我们会第一时间内为您处理。

Copyright© 2022 湘ICP备2022001581号-3