跳至内容

直接使用请求

到目前为止，您一直在使用其类型声明您需要的请求部分。

从以下位置获取数据

  • 路径作为参数。
  • 头部。
  • Cookie。
  • 等等。

通过这样做，FastAPI 会自动验证这些数据、转换这些数据并为您的 API 生成文档。

但在某些情况下，您可能需要直接访问 Request 对象。

关于 Request 对象的详细信息

由于FastAPI 实际上是在Starlette之上，并在其之上添加了几种工具，因此当您需要时，可以直接使用 Starlette 的 Request 对象。

这也意味着，如果您直接从 Request 对象获取数据（例如，读取主体），则 FastAPI 不会验证、转换或记录（使用 OpenAPI，用于自动 API 用户界面）该数据。

尽管任何其他正常声明的参数（例如，使用 Pydantic 模型的主体）仍然会被验证、转换、注释等。

但有一些特定情况需要获取 Request 对象。

直接使用 Request 对象

假设您想在路径操作函数内部获取客户端的 IP 地址/主机。

为此，您需要直接访问请求。

from fastapi import FastAPI, Request

app = FastAPI()


@app.get("/items/{item_id}")
def read_root(item_id: str, request: Request):
    client_host = request.client.host
    return {"client_host": client_host, "item_id": item_id}

通过声明一个类型为 Request 的路径操作函数参数，FastAPI 将知道将 Request 传递到该参数中。

提示

请注意，在这种情况下，我们在请求参数旁边声明了一个路径参数。

因此，路径参数将被提取、验证、转换为指定类型并使用 OpenAPI 进行注释。

同样，您可以像往常一样声明任何其他参数，并且还可以获取 Request。

Request 文档

您可以在 Starlette 官方文档网站上 阅读有关 Request 对象的更多详细信息。

"技术细节"

您也可以使用 from starlette.requests import Request。

FastAPI 直接提供它只是为了方便您，即开发者。但它直接来自 Starlette。