跳转至

直接使用 Request

🌐 Translation by AI and humans

This translation was made by AI guided by humans. 🤝

It could have mistakes of misunderstanding the original meaning, or looking unnatural, etc. 🤖

You can improve this translation by helping us guide the AI LLM better.

English version

至此，我们已经使用多种类型声明了请求的各种组件。

并从以下对象中提取数据：

  • 路径参数
  • 请求头
  • Cookies
  • 等

FastAPI 使用这种方式验证数据、转换数据，并自动生成 API 文档。

但有时，我们也需要直接访问 Request 对象。

Request 对象的细节

实际上，FastAPI 的底层是 Starlette，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}
🤓 Other versions and variants 
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。