8.FastAPI Header参数

8.FastAPI Header参数

在FastAPI中，使用fastapi模块的Header来声明Header参数。与 Path, Query 和Body一样，第一个参数是默认值，也可以设置注释和校验。

由于大部分标准的headers用 "连字符" 也就是 "减号" (-)分隔，所以在默认情况下, Header 会把参数名称的字符从下划线 (_) 转换为连字符 (-) 来提取并记录 headers。同时，HTTP headers 是大小写不敏感的，所以可以使用标准Python样式(也称为 "snake_case")声明它们。也就是说，FastAPI会自动转换大小写和下划线。

对于重复的headers，可以使用列表来接收所有的值。

代码示例：

from fastapi import FastAPI
from fastapi import Header
​
app = FastAPI()
​
@app.get(path='/test')
async def test(user_agent: str = Header(None)):
    return {"user_agent": user_agent}

执行请求：

curl http://127.0.0.1:8000/test
{"user_agent":"curl/7.55.1"}