Header 参数

    首先导入 Header:

    然后使用和Path, Query and Cookie 一样的结构定义 header 参数

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

    1. from typing import Union
    3. from fastapi import FastAPI, Header
    7. @app.get("/items/")
    8. async def read_items(user_agent: Union[str, None] = Header(default=None)):
    9.     return {"User-Agent": user_agent}

    技术细节

    Header 是 Path, 和 Cookie 的兄弟类型。它也继承自通用的 Param 类.

    但是请记得，当你从fastapi导入 Query, Path, Header, 或其他时，实际上导入的是返回特定类型的函数。

    Info

    Header 在 Path, Query 和 Cookie 提供的功能之上有一点额外的功能。

    大多数标准的headers用 “连字符” 分隔，也称为 “减号” (-)。

    但是像 user-agent 这样的变量在Python中是无效的。

    因此, 默认情况下, Header 将把参数名称的字符从下划线 (_) 转换为连字符 (-) 来提取并记录 headers.

    同时，HTTP headers 是大小写不敏感的，因此，因此可以使用标准Python样式(也称为 “snake_case”)声明它们。

    因此，您可以像通常在Python代码中那样使用 user_agent ，而不需要将首字母大写为 User_Agent 或类似的东西。

    如果出于某些原因，你需要禁用下划线到连字符的自动转换，设置Header的参数 convert_underscores 为 False:

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

    有可能收到重复的headers。这意味着，相同的header具有多个值。

    您可以在类型声明中使用一个list来定义这些情况。

    你可以通过一个Python list 的形式获得重复header的所有值。

    比如, 为了声明一个 X-Token header 可以出现多次，你可以这样写：

    1. from typing import List, Union
    3. from fastapi import FastAPI, Header
    7. @app.get("/items/")
    8. async def read_items(x_token: Union[List[str], None] = Header(default=None)):
    9.     return {"X-Token values": x_token}

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

    响应会是:

    1. {
    2.     "X-Token values": [
    3.         "bar",
    4.         "foo"
    5. }

    不用担心变量中的下划线，FastAPI 会负责转换它们。