【FastAPI基础】12、Cookie 及 Header

引言：

最近工作中有机会接触FastAPI这个框架，所以就把官方文档看了一遍，对框架的各个特性及使用方法做了总结，会逐步的发出来，希望对您有用。

如果您之前接触过python的其他框架，看起来会非常简单和顺畅，其实就是很简单。

【上一篇】：【FastAPI基础】11、额外数据类型，拓展下
【下一篇】：【FastAPI基础】13、响应模型
【FastAPI搭建好的产品框架源码，直接上手】：【FastAPI搭建好的产品架构】，直接上手

1、声明 Cookie 参数
声明 Cookie 参数的结构与声明 Query 参数和 Path 参数时相同。
第一个值是参数的默认值，同时也可以传递所有验证参数或注释参数，来校验参数：

from typing import Optional
from fastapi import Cookie, FastAPI

app = FastAPI()


@app.get("/items/")
async def read_items(ads_id: Optional[str] = Cookie(None)):
    return {"ads_id": ads_id}

2、声明 Header 参数
然后使用和Path, Query and Cookie 一样的结构定义 header 参数。
第一个值是默认值，你可以传递所有的额外验证或注释参数：

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}

2.1、自动转换
Header 在 Path, Query 和 Cookie 提供的功能之上有一点额外的功能。
大多数标准的headers用 “连字符” 分隔，也称为 “减号” (-)。
但是像 user-agent 这样的变量在Python中是无效的。
因此, 默认情况下, Header 将把参数名称的字符从下划线 (_) 转换为连字符 (-) 来提取并记录 headers.
同时，HTTP headers 是大小写不敏感的，因此，因此可以使用标准Python样式(也称为 “snake_case”)声明它们。
因此，您可以像通常在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}

• Warning
• 在设置 convert_underscores 为 False 之前，请记住，一些HTTP代理和服务器不允许使用带有下划线的headers。

2.2、 重复的 headers
有可能收到重复的headers。这意味着，相同的header具有多个值。
您可以在类型声明中使用一个list来定义这些情况。
你可以通过一个Python list 的形式获得重复header的所有值。
比如, 为了声明一个 X-Token header 可以出现多次，你可以这样写：

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

app = FastAPI()


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

如果你与路径操作通信时发送两个HTTP headers，就像：

X-Token: foo
X-Token: bar

响应会是:

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