FastAPI 中怎么设置超时时间？FastAPI 中设置超时时间的几种方法

FastAPI 提供了多种设置超时时间的方法，从全局级别到路由级别的设置都可用，以确保请求不会无限期地等待响应。

用 Apifox，节省研发团队的每一分钟

FastAPI 中怎么设置超时时间？FastAPI 中设置超时时间的几种方法

免费使用 Apifox

相关推荐

最新文章

FastAPI 是一个现代的 Python Web 框架，具有出色的性能和异步支持。在构建 Web 应用程序时，通常需要设置超时时间以确保请求不会无限期地等待响应。本文将介绍在 FastAPI 中设置超时时间的几种方法，并提供实际案例以帮助你更好地理解和应用这些方法。

fastapi 中设置超时时间
FastAPI 官网

超时时间的基本概念

在开始讨论 FastAPI 中的超时设置方法之前，让我们先了解一下超时时间的基本概念。超时时间是指在发送请求后等待响应的最长时间。如果在超时时间内未收到响应，请求将被取消或中断，以避免无限期地等待。超时时间对于处理潜在的长时间运行的请求或网络问题非常重要。

方法一：应用级别的超时设置

一种设置 FastAPI 应用程序全局超时时间的方法是使用TimeoutMiddleware中间件。以下是一个示例：

from fastapi import FastAPI
from fastapi.middleware.timeout import TimeoutMiddleware
from datetime import timedelta

app = FastAPI()

# 设置应用程序的默认超时时间为5秒
app.add_middleware(TimeoutMiddleware, timeout=timedelta(seconds=5))

@app.get("/")
async def read_root():
    return {"message": "Hello, World!"}

上述示例中，我们使用TimeoutMiddleware将应用程序的默认超时时间设置为 5 秒。这意味着应用程序中的所有请求都将受到 5 秒的超时限制。

方法二：路由级别的超时设置

如果你希望为特定路由设置不同的超时时间，可以在路由处理函数中使用timeout参数。以下是一个示例：

from fastapi import FastAPI
from datetime import timedelta

app = FastAPI()

@app.get("/slow_endpoint")
async def slow_endpoint():
    return {"message": "This is a slow endpoint."}

@app.get("/fast_endpoint", timeout=timedelta(seconds=2))
async def fast_endpoint():
    return {"message": "This is a fast endpoint."}

在上述示例中，slow_endpoint没有指定超时时间，因此它将使用应用程序默认的 5 秒超时时间。而fast_endpoint则明确设置了 2 秒的超时时间。

实践案例

为了演示超时设置的实际用例，让我们考虑一个模拟长时间运行的请求的示例。我们将创建一个路由处理函数，该函数模拟执行一个需要较长时间才能完成的任务。

import asyncio
from fastapi import FastAPI, Request

app = FastAPI(timeout_client=1) 

@app.get("/long-request")
async def long_request(request: Request):
    await asyncio.sleep(10) # 模拟长时间操作
    return {"message": "Returned after long request"}

@app.get("/standard-request") 
async def standard_request(request: Request):
    await asyncio.sleep(1) 
    return {"message": "Returned after standard request"}

if __name__ == "__main__":
    import uvicorn
    uvicorn.run(app, host="127.0.0.1", port=8000)

在上面的示例中，全局超时时间是 1 秒。/long-request 路由会超过超时时间，被终止；而 /standard-request 正常返回。

FastAPI 超时时间实践案例
FastAPI 超时时间实践案例结果

提示、技巧和注意事项

  • 超时时间的设置取决于你的应用程序需求和性能要求。请根据你的具体情况选择合适的超时策略。
  • 在生产环境中，超时时间的设置可能受到部署服务器（如代理服务器或反向代理服务器）的影响。确保在实际部署前进行适当的测试。

使用 Apifox 调试 FastAPI 接口

如果你是 FastAPI 开发者，你经常需要与 API 打交道，确保你的应用程序能够正常工作。这时，一个强大的接口测试工具就会派上用场。

Apifox 是一个比 Postman 更强大的接口测试工具，Apifox = Postman + Swagger + Mock + JMeter，Apifox 支持调试 http(s)、WebSocket、Socket、gRPC、Dubbo 等协议的接口，并且集成了 IDEA 插件。在写完服务接口时，测试阶段可以通过 Apifox 来校验接口的正确性，图形化界面极大的方便了项目的上线效率。


如果想快速的调试一条接口，新建一个项目后，在项目中选择“调试模式”，填写请求地址后即可快速发送请求，并获得响应结果，上文的实践案例如图所示：

立即体验 Apifox
使用 Apifox 调试后端 fastapi 接口
Apifox 调试接口

总结

FastAPI 提供了多种设置超时时间的方法，从全局级别到路由级别的设置都可用。了解这些设置方法并根据你的应用程序需求进行适当的配置将有助于确保请求得到及时响应并提高用户体验。

知识扩展：



参考链接：

  • FastAPI 官方文档：https://fastapi.tiangolo.com/
  • FastAPI GitHub 仓库：https://github.com/tiangolo/fastapi
  • Python timedelta 文档：https://docs.python.org/3/library/datetime.html#timedelta-objects
fastapi Python
相关推荐