跳转至

Cookie 参数⚓︎

你可以像定义 Query 参数和 Path 参数一样来定义 Cookie 参数。

首先,导入 Cookie:

=== "Python 3.10+"

```Python hl_lines="3"
{!> ../../../docs_src/cookie_params/tutorial001_an_py310.py!}
```

=== "Python 3.9+"

```Python hl_lines="3"
{!> ../../../docs_src/cookie_params/tutorial001_an_py39.py!}
```

=== "Python 3.8+"

```Python hl_lines="3"
{!> ../../../docs_src/cookie_params/tutorial001_an.py!}
```

=== "Python 3.10+ non-Annotated"

!!! tip
    尽可能选择使用 `Annotated` 的版本。

```Python hl_lines="1"
{!> ../../../docs_src/cookie_params/tutorial001_py310.py!}
```

=== "Python 3.8+ non-Annotated"

!!! tip
    尽可能选择使用 `Annotated` 的版本。

```Python hl_lines="3"
{!> ../../../docs_src/cookie_params/tutorial001.py!}
```

声明 Cookie 参数的结构与声明 Query 参数和 Path 参数时相同。

第一个值是参数的默认值,同时也可以传递所有验证参数或注释参数,来校验参数:

=== "Python 3.10+"

```Python hl_lines="9"
{!> ../../../docs_src/cookie_params/tutorial001_an_py310.py!}
```

=== "Python 3.9+"

```Python hl_lines="9"
{!> ../../../docs_src/cookie_params/tutorial001_an_py39.py!}
```

=== "Python 3.8+"

```Python hl_lines="10"
{!> ../../../docs_src/cookie_params/tutorial001_an.py!}
```

=== "Python 3.10+ non-Annotated"

!!! tip
    尽可能选择使用 `Annotated` 的版本。

```Python hl_lines="7"
{!> ../../../docs_src/cookie_params/tutorial001_py310.py!}
```

=== "Python 3.8+ non-Annotated"

!!! tip
    尽可能选择使用 `Annotated` 的版本。

```Python hl_lines="9"
{!> ../../../docs_src/cookie_params/tutorial001.py!}
```

技术细节

CookiePathQuery是兄弟类,它们都继承自公共的 Param

但请记住,当你从 fastapi 导入的 QueryPathCookie 或其他参数声明函数,这些实际上是返回特殊类的函数。

Info

你需要使用 Cookie 来声明 cookie 参数,否则参数将会被解释为查询参数。

总结⚓︎

使用 Cookie 声明 cookie 参数,使用方式与 QueryPath 类似。


最后更新: November 25, 2023
创建日期: November 25, 2023