FastAPI Header参数

定义Header参数的方式与定义Query、Path、Cookie参数相同。

第一个值是默认值，还可以传递所有验证参数或注释参数：

from typing import Optional
from fastapi import FastAPI, Header

app = FastAPI()

@app.get("/items/")
async def read_items(user_agent: Optional[str] = Header(None)):
    return {"User-Agent": user_agent}

自动转换

Header比Path、Query和Cookie提供了更多功能。大部分标准请求头用连字符分隔，即减号，但是user-agent这样的变量在python中无效的，因此，在默认情况下，Header把参数名中的字符由下划线改为连字符来提取并存档请求头，同时，HTTP的请求头不区分大小写，可以使用Python标准样式进行声明，因此，可以像在Python代码中一样使用User_agent，无需把首字母大写为User_Agent等形式，如需禁用下画线自动转换为连字符，可以把Header的convert_underscores参数设置为False：

from typing import Optional
from fastapi import FastAPI, Header

app = FastAPI()

@app.get("/items/")
async def read_items(
  strange_header: Optional[str] = Header(None, convert_underscores=False)  
):
    return {"strange_header": strange_header}

重复的请求头

有时，可能需要接收重复的请求头，即同一个请求头有多值，类型声明中可以使用list定义多个请求头。使用Python list可以接收重复请求头所有的值。

例如：声明X-Token多次出现的请求头，可以写成这样：

from typing import List, Optional
from fastapi import FastAPI, Header

app = FastAPI()

@app.get("/items/")
async def read_item(x_token: Optional[List[str]] = Header(None)):
    return {"X-Token value": x_token}

与路径操作通信时，以下面的方式发送两个HTTP请求头：

X-Token: foo
X-Token: bar

响应结果：

{
    "X-Token values": [
        "bar",
        "foo"
    ]
}