|
|
@ -1,10 +1,10 @@ |
|
|
|
# Header 参数 |
|
|
|
|
|
|
|
你可以使用定义 `Query`, `Path` 和 `Cookie` 参数一样的方法定义 Header 参数。 |
|
|
|
定义 `Header` 参数的方式与定义 `Query`、`Path`、`Cookie` 参数相同。 |
|
|
|
|
|
|
|
## 导入 `Header` |
|
|
|
|
|
|
|
首先导入 `Header`: |
|
|
|
首先,导入 `Header`: |
|
|
|
|
|
|
|
=== "Python 3.10+" |
|
|
|
|
|
|
@ -44,9 +44,9 @@ |
|
|
|
|
|
|
|
## 声明 `Header` 参数 |
|
|
|
|
|
|
|
然后使用和`Path`, `Query` and `Cookie` 一样的结构定义 header 参数 |
|
|
|
然后,使用和 `Path`、`Query`、`Cookie` 一样的结构定义 header 参数。 |
|
|
|
|
|
|
|
第一个值是默认值,你可以传递所有的额外验证或注释参数: |
|
|
|
第一个值是默认值,还可以传递所有验证参数或注释参数: |
|
|
|
|
|
|
|
=== "Python 3.10+" |
|
|
|
|
|
|
@ -85,28 +85,30 @@ |
|
|
|
``` |
|
|
|
|
|
|
|
!!! note "技术细节" |
|
|
|
`Header` 是 `Path`, `Query` 和 `Cookie` 的兄弟类型。它也继承自通用的 `Param` 类. |
|
|
|
|
|
|
|
但是请记得,当你从`fastapi`导入 `Query`, `Path`, `Header`, 或其他时,实际上导入的是返回特定类型的函数。 |
|
|
|
`Header` 是 `Path`、`Query`、`Cookie` 的**兄弟类**,都继承自共用的 `Param` 类。 |
|
|
|
|
|
|
|
!!! info |
|
|
|
为了声明headers, 你需要使用`Header`, 因为否则参数将被解释为查询参数。 |
|
|
|
注意,从 `fastapi` 导入的 `Query`、`Path`、`Header` 等对象,实际上是返回特殊类的函数。 |
|
|
|
|
|
|
|
!!! info "说明" |
|
|
|
|
|
|
|
必须使用 `Header` 声明 header 参数,否则该参数会被解释为查询参数。 |
|
|
|
|
|
|
|
## 自动转换 |
|
|
|
|
|
|
|
`Header` 在 `Path`, `Query` 和 `Cookie` 提供的功能之上有一点额外的功能。 |
|
|
|
`Header` 比 `Path`、`Query` 和 `Cookie` 提供了更多功能。 |
|
|
|
|
|
|
|
大多数标准的headers用 "连字符" 分隔,也称为 "减号" (`-`)。 |
|
|
|
大部分标准请求头用**连字符**分隔,即**减号**(`-`)。 |
|
|
|
|
|
|
|
但是像 `user-agent` 这样的变量在Python中是无效的。 |
|
|
|
但是 `user-agent` 这样的变量在 Python 中是无效的。 |
|
|
|
|
|
|
|
因此, 默认情况下, `Header` 将把参数名称的字符从下划线 (`_`) 转换为连字符 (`-`) 来提取并记录 headers. |
|
|
|
因此,默认情况下,`Header` 把参数名中的字符由下划线(`_`)改为连字符(`-`)来提取并存档请求头 。 |
|
|
|
|
|
|
|
同时,HTTP headers 是大小写不敏感的,因此,因此可以使用标准Python样式(也称为 "snake_case")声明它们。 |
|
|
|
同时,HTTP 的请求头不区分大小写,可以使用 Python 标准样式(即 **snake_case**)进行声明。 |
|
|
|
|
|
|
|
因此,您可以像通常在Python代码中那样使用 `user_agent` ,而不需要将首字母大写为 `User_Agent` 或类似的东西。 |
|
|
|
因此,可以像在 Python 代码中一样使用 `user_agent` ,无需把首字母大写为 `User_Agent` 等形式。 |
|
|
|
|
|
|
|
如果出于某些原因,你需要禁用下划线到连字符的自动转换,设置`Header`的参数 `convert_underscores` 为 `False`: |
|
|
|
如需禁用下划线自动转换为连字符,可以把 `Header` 的 `convert_underscores` 参数设置为 `False`: |
|
|
|
|
|
|
|
=== "Python 3.10+" |
|
|
|
|
|
|
@ -144,19 +146,20 @@ |
|
|
|
{!> ../../../docs_src/header_params/tutorial002.py!} |
|
|
|
``` |
|
|
|
|
|
|
|
!!! warning |
|
|
|
在设置 `convert_underscores` 为 `False` 之前,请记住,一些HTTP代理和服务器不允许使用带有下划线的headers。 |
|
|
|
!!! warning "警告" |
|
|
|
|
|
|
|
注意,使用 `convert_underscores = False` 要慎重,有些 HTTP 代理和服务器不支持使用带有下划线的请求头。 |
|
|
|
|
|
|
|
|
|
|
|
## 重复的 headers |
|
|
|
## 重复的请求头 |
|
|
|
|
|
|
|
有可能收到重复的headers。这意味着,相同的header具有多个值。 |
|
|
|
有时,可能需要接收重复的请求头。即同一个请求头有多个值。 |
|
|
|
|
|
|
|
您可以在类型声明中使用一个list来定义这些情况。 |
|
|
|
类型声明中可以使用 `list` 定义多个请求头。 |
|
|
|
|
|
|
|
你可以通过一个Python `list` 的形式获得重复header的所有值。 |
|
|
|
使用 Python `list` 可以接收重复请求头所有的值。 |
|
|
|
|
|
|
|
比如, 为了声明一个 `X-Token` header 可以出现多次,你可以这样写: |
|
|
|
例如,声明 `X-Token` 多次出现的请求头,可以写成这样: |
|
|
|
|
|
|
|
=== "Python 3.10+" |
|
|
|
|
|
|
@ -203,14 +206,14 @@ |
|
|
|
{!> ../../../docs_src/header_params/tutorial003.py!} |
|
|
|
``` |
|
|
|
|
|
|
|
如果你与*路径操作*通信时发送两个HTTP headers,就像: |
|
|
|
与*路径操作*通信时,以下面的方式发送两个 HTTP 请求头: |
|
|
|
|
|
|
|
``` |
|
|
|
X-Token: foo |
|
|
|
X-Token: bar |
|
|
|
``` |
|
|
|
|
|
|
|
响应会是: |
|
|
|
响应结果是: |
|
|
|
|
|
|
|
```JSON |
|
|
|
{ |
|
|
@ -221,8 +224,8 @@ X-Token: bar |
|
|
|
} |
|
|
|
``` |
|
|
|
|
|
|
|
## 回顾 |
|
|
|
## 小结 |
|
|
|
|
|
|
|
使用 `Header` 来声明 header , 使用和 `Query`, `Path` 与 `Cookie` 相同的模式。 |
|
|
|
使用 `Header` 声明请求头的方式与 `Query`、`Path` 、`Cookie` 相同。 |
|
|
|
|
|
|
|
不用担心变量中的下划线,**FastAPI** 会负责转换它们。 |
|
|
|
不用担心变量中的下划线,**FastAPI** 可以自动转换。 |
|
|
|