8000 🌐 Add Chinese translation for `docs/zh/docs/tutorial/cookie-param-mod… · fastapi/fastapi@9802b90 · GitHub
[go: up one dir, main page]

Skip to content

Commit 9802b90

Browse files
🌐 Add Chinese translation for docs/zh/docs/tutorial/cookie-param-models.md (#13038)
1 parent 6c8deb5 commit 9802b90

File tree

1 file changed

+76
-0
lines changed

1 file changed

+76
-0
lines changed
Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# Cookie 参数模型
2+
3+
如果您有一组相关的 **cookie**,您可以创建一个 **Pydantic 模型**来声明它们。🍪
4+
5+
这将允许您在**多个地方**能够**重用模型**,并且可以一次性声明所有参数的验证方式和元数据。😎
6+
7+
/// note
8+
9+
自 FastAPI 版本 `0.115.0` 起支持此功能。🤓
10+
11+
///
12+
13+
/// tip
14+
15+
此技术同样适用于 `Query``Cookie``Header` 。😎
16+
17+
///
18+
19+
## 带有 Pydantic 模型的 Cookie
20+
21+
**Pydantic** 模型中声明所需的 **cookie** 参数,然后将参数声明为 `Cookie`
22+
23+
{* ../../docs_src/cookie_param_models/tutorial001_an_py310.py hl[9:12,16] *}
24+
25+
**FastAPI** 将从请求中接收到的 **cookie****提取****每个字段**的数据,并提供您定义的 Pydantic 模型。
26+
27+
## 查看文档
28+
29+
您可以在文档 UI 的 `/docs` 中查看定义的 cookie:
30+
31+
<div class="screenshot">
32+
<img src="/img/tutorial/cookie-param-models/image01.png">
33+
</div>
34+
35+
/// info
36+
37+
请记住,由于**浏览器**以特殊方式**处理 cookie**,并在后台进行操作,因此它们**不会**轻易允许 **JavaScript** 访问这些 cookie。
38+
39+
如果您访问 `/docs`**API 文档 UI**,您将能够查看您*路径操作*的 cookie **文档**
40+
41+
但是即使您**填写数据**并点击“执行”,由于文档界面使用 **JavaScript**,cookie 将不会被发送。而您会看到一条**错误**消息,就好像您没有输入任何值一样。
42+
43+
///
44+
45+
## 禁止额外的 Cookie
46+
47+
在某些特殊使用情况下(可能并不常见),您可能希望**限制**您想要接收的 cookie。
48+
49+
您的 API 现在可以控制自己的 <abbr title="顺带一提,这是一个笑话。它与 cookie 同意无关,但现在连API都能拒绝那些可怜的 cookie,真是太有意思了。来,吃块小饼干(cookie)吧。🍪">cookie 同意</abbr>。🤪🍪
50+
51+
您可以使用 Pydantic 的模型配置来禁止( `forbid` )任何额外( `extra` )字段:
52+
53+
{* ../../docs_src/cookie_param_models/tutorial002_an_py39.py hl[10] *}
54+
55+
如果客户尝试发送一些**额外的 cookie**,他们将收到**错误**响应。
56+
57+
可怜的 cookie 通知条,费尽心思为了获得您的同意,却被<abbr title="这又是一个笑话,别管我了,给您的小饼干(cookie)配上点咖啡吧。☕">API 拒绝了</abbr>。🍪
58+
59+
例如,如果客户端尝试发送一个值为 `good-list-please``santa_tracker` cookie,客户端将收到一个**错误**响应,告知他们 `santa_tracker` <abbr title="圣诞老人(Santa)不赞成没有小饼干(cookie)。🎅 好吧,不会再开 cookie 的玩笑了。">cookie 是不允许的</abbr>:
60+
61+
```json
62+
{
63+
"detail": [
64+
{
65+
"type": "extra_forbidden",
66+
"loc": ["cookie", "santa_tracker"],
67+
"msg": "Extra inputs are not permitted",
68+
"input": "good-list-please",
69+
}
70+
]
71+
}
72+
```
73+
74+
## 总结
75+
76+
您可以使用 **Pydantic 模型****FastAPI** 中声明 <abbr title="走之前再来块小饼干吧。 🍪">**cookie**</abbr>。😎

0 commit comments

Comments
 (0)
0