- FastAPI教程
- FastAPI - 主页
- FastAPI - 简介
- FastAPI - 你好世界
- FastAPI-开放API
- FastAPI - Uvicorn
- FastAPI - 类型提示
- FastAPI - IDE 支持
- FastAPI - 休息架构
- FastAPI - 路径参数
- FastAPI - 查询参数
- FastAPI - 参数验证
- FastAPI - Pydantic
- FastAPI - 请求正文
- FastAPI - 模板
- FastAPI - 静态文件
- FastAPI - HTML 表单模板
- FastAPI - 访问表单数据
- FastAPI - 上传文件
- FastAPI - Cookie 参数
- FastAPI - 标头参数
- FastAPI - 响应模型
- FastAPI - 嵌套模型
- FastAPI - 依赖关系
- FastAPI - CORS
- FastAPI - Crud 操作
- FastAPI - SQL 数据库
- FastAPI - 使用 MongoDB
- FastAPI - 使用 GraphQL
- FastAPI - Websocket
- FastAPI - FastAPI 事件处理程序
- FastAPI - 安装子应用程序
- FastAPI - 中间件
- FastAPI - 安装 Flask 应用程序
- FastAPI - 部署
- FastAPI 有用资源
- FastAPI - 快速指南
- FastAPI - 有用的资源
- FastAPI - 讨论
FastAPI - 标头参数
为了读取作为客户端请求一部分的HTTP 标头的值,请从 FastAPI 库导入 Header 对象,并在操作函数定义中声明 Header 类型的参数。参数名称应与camel_case中转换的HTTP标头匹配。
在以下示例中,将检索“accept-language”标头。由于Python不允许在标识符名称中使用“-”(破折号),因此将其替换为“_”(下划线)
from typing import Optional from fastapi import FastAPI, Header app = FastAPI() @app.get("/headers/") async def read_header(accept_language: Optional[str] = Header(None)): return {"Accept-Language": accept_language}
如以下 Swagger 文档所示,检索到的标头显示为响应正文。
您可以在响应对象中推送自定义标头和预定义标头。操作函数应该有一个Response类型的参数。为了设置自定义标头,其名称应以“X”为前缀。在以下情况下,将添加一个名为“X-Web-Framework”的自定义标头和一个预定义标头“Content-Language”以及操作函数的响应。
from fastapi import FastAPI from fastapi.responses import JSONResponse app = FastAPI() @app.get("/rspheader/") def set_rsp_headers(): content = {"message": "Hello World"} headers = {"X-Web-Framework": "FastAPI", "Content-Language": "en-US"} return JSONResponse(content=content, headers=headers)
新添加的标头将出现在文档的响应标头部分中。