FastAPI 中如何设置响应头？-JavaScript中文网-JavaScript教程资源分享门户

推荐答案

在 FastAPI 中，可以通过 Response 对象来设置响应头。具体步骤如下：

导入 Response 对象。
在路由处理函数中，将 Response 对象作为参数传入。
使用 Response.headers 属性来设置响应头。

示例代码如下：

// www.javascriptcn.com code example
from fastapi import FastAPI, Response

app = FastAPI()

@app.get("/set-headers/")
def set_headers(response: Response):
    response.headers["Custom-Header"] = "Custom-Value"
    response.headers["Another-Header"] = "Another-Value"
    return {"message": "Headers set successfully"}

本题详细解读

1. 导入 `Response` 对象

在 FastAPI 中，Response 对象用于控制 HTTP 响应的各个方面，包括状态码、响应头和响应体等。要使用 Response 对象，首先需要从 fastapi 模块中导入它。

from fastapi import Response

2. 在路由处理函数中使用 `Response` 对象

在定义路由处理函数时，可以将 Response 对象作为参数传入。这样，你就可以在函数内部操作 Response 对象，从而设置响应头。

@app.get("/set-headers/")
def set_headers(response: Response):
    # 设置响应头
    response.headers["Custom-Header"] = "Custom-Value"
    response.headers["Another-Header"] = "Another-Value"
    return {"message": "Headers set successfully"}

3. 使用 `Response.headers` 属性设置响应头

Response.headers 是一个字典，用于存储 HTTP 响应头。你可以通过直接赋值的方式向其中添加自定义的响应头。

response.headers["Custom-Header"] = "Custom-Value"
response.headers["Another-Header"] = "Another-Value"

4. 返回响应

在设置完响应头后，你可以返回一个 JSON 响应体，或者任何其他类型的响应体。FastAPI 会自动将响应头和响应体组合成一个完整的 HTTP 响应。

return {"message": "Headers set successfully"}

5. 运行并测试

启动 FastAPI 应用后，访问 /set-headers/ 路径，你将看到响应头中包含了自定义的 Custom-Header 和 Another-Header。

curl -i http://127.0.0.1:8000/set-headers/

响应头示例：

HTTP/1.1 200 OK
content-length: 35
content-type: application/json
custom-header: Custom-Value
another-header: Another-Value

通过这种方式，你可以在 FastAPI 中灵活地设置响应头，以满足不同的业务需求。

FastAPI 中如何设置响应头？