Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' into docs/pt_advanced-events
- Loading branch information
Showing
125 changed files
with
18,865 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,240 @@ | ||
# 🌖 📨 🗄 | ||
|
||
!!! warning | ||
👉 👍 🏧 ❔. | ||
|
||
🚥 👆 ▶️ ⏮️ **FastAPI**, 👆 💪 🚫 💪 👉. | ||
|
||
👆 💪 📣 🌖 📨, ⏮️ 🌖 👔 📟, 🔉 🆎, 📛, ♒️. | ||
|
||
👈 🌖 📨 🔜 🔌 🗄 🔗, 👫 🔜 😑 🛠️ 🩺. | ||
|
||
✋️ 👈 🌖 📨 👆 ✔️ ⚒ 💭 👆 📨 `Response` 💖 `JSONResponse` 🔗, ⏮️ 👆 👔 📟 & 🎚. | ||
|
||
## 🌖 📨 ⏮️ `model` | ||
|
||
👆 💪 🚶♀️ 👆 *➡ 🛠️ 👨🎨* 🔢 `responses`. | ||
|
||
⚫️ 📨 `dict`, 🔑 👔 📟 🔠 📨, 💖 `200`, & 💲 🎏 `dict`Ⓜ ⏮️ ℹ 🔠 👫. | ||
|
||
🔠 👈 📨 `dict`Ⓜ 💪 ✔️ 🔑 `model`, ⚗ Pydantic 🏷, 💖 `response_model`. | ||
|
||
**FastAPI** 🔜 ✊ 👈 🏷, 🏗 🚮 🎻 🔗 & 🔌 ⚫️ ☑ 🥉 🗄. | ||
|
||
🖼, 📣 ➕1️⃣ 📨 ⏮️ 👔 📟 `404` & Pydantic 🏷 `Message`, 👆 💪 ✍: | ||
|
||
```Python hl_lines="18 22" | ||
{!../../../docs_src/additional_responses/tutorial001.py!} | ||
``` | ||
|
||
!!! note | ||
✔️ 🤯 👈 👆 ✔️ 📨 `JSONResponse` 🔗. | ||
|
||
!!! info | ||
`model` 🔑 🚫 🍕 🗄. | ||
|
||
**FastAPI** 🔜 ✊ Pydantic 🏷 ⚪️➡️ 📤, 🏗 `JSON Schema`, & 🚮 ⚫️ ☑ 🥉. | ||
|
||
☑ 🥉: | ||
|
||
* 🔑 `content`, 👈 ✔️ 💲 ➕1️⃣ 🎻 🎚 (`dict`) 👈 🔌: | ||
* 🔑 ⏮️ 📻 🆎, ✅ `application/json`, 👈 🔌 💲 ➕1️⃣ 🎻 🎚, 👈 🔌: | ||
* 🔑 `schema`, 👈 ✔️ 💲 🎻 🔗 ⚪️➡️ 🏷, 📥 ☑ 🥉. | ||
* **FastAPI** 🚮 🔗 📥 🌐 🎻 🔗 ➕1️⃣ 🥉 👆 🗄 ↩️ ✅ ⚫️ 🔗. 👉 🌌, 🎏 🈸 & 👩💻 💪 ⚙️ 👈 🎻 🔗 🔗, 🚚 👻 📟 ⚡ 🧰, ♒️. | ||
|
||
🏗 📨 🗄 👉 *➡ 🛠️* 🔜: | ||
|
||
```JSON hl_lines="3-12" | ||
{ | ||
"responses": { | ||
"404": { | ||
"description": "Additional Response", | ||
"content": { | ||
"application/json": { | ||
"schema": { | ||
"$ref": "#/components/schemas/Message" | ||
} | ||
} | ||
} | ||
}, | ||
"200": { | ||
"description": "Successful Response", | ||
"content": { | ||
"application/json": { | ||
"schema": { | ||
"$ref": "#/components/schemas/Item" | ||
} | ||
} | ||
} | ||
}, | ||
"422": { | ||
"description": "Validation Error", | ||
"content": { | ||
"application/json": { | ||
"schema": { | ||
"$ref": "#/components/schemas/HTTPValidationError" | ||
} | ||
} | ||
} | ||
} | ||
} | ||
} | ||
``` | ||
|
||
🔗 🔗 ➕1️⃣ 🥉 🔘 🗄 🔗: | ||
|
||
```JSON hl_lines="4-16" | ||
{ | ||
"components": { | ||
"schemas": { | ||
"Message": { | ||
"title": "Message", | ||
"required": [ | ||
"message" | ||
], | ||
"type": "object", | ||
"properties": { | ||
"message": { | ||
"title": "Message", | ||
"type": "string" | ||
} | ||
} | ||
}, | ||
"Item": { | ||
"title": "Item", | ||
"required": [ | ||
"id", | ||
"value" | ||
], | ||
"type": "object", | ||
"properties": { | ||
"id": { | ||
"title": "Id", | ||
"type": "string" | ||
}, | ||
"value": { | ||
"title": "Value", | ||
"type": "string" | ||
} | ||
} | ||
}, | ||
"ValidationError": { | ||
"title": "ValidationError", | ||
"required": [ | ||
"loc", | ||
"msg", | ||
"type" | ||
], | ||
"type": "object", | ||
"properties": { | ||
"loc": { | ||
"title": "Location", | ||
"type": "array", | ||
"items": { | ||
"type": "string" | ||
} | ||
}, | ||
"msg": { | ||
"title": "Message", | ||
"type": "string" | ||
}, | ||
"type": { | ||
"title": "Error Type", | ||
"type": "string" | ||
} | ||
} | ||
}, | ||
"HTTPValidationError": { | ||
"title": "HTTPValidationError", | ||
"type": "object", | ||
"properties": { | ||
"detail": { | ||
"title": "Detail", | ||
"type": "array", | ||
"items": { | ||
"$ref": "#/components/schemas/ValidationError" | ||
} | ||
} | ||
} | ||
} | ||
} | ||
} | ||
} | ||
``` | ||
|
||
## 🌖 🔉 🆎 👑 📨 | ||
|
||
👆 💪 ⚙️ 👉 🎏 `responses` 🔢 🚮 🎏 🔉 🆎 🎏 👑 📨. | ||
|
||
🖼, 👆 💪 🚮 🌖 📻 🆎 `image/png`, 📣 👈 👆 *➡ 🛠️* 💪 📨 🎻 🎚 (⏮️ 📻 🆎 `application/json`) ⚖️ 🇩🇴 🖼: | ||
|
||
```Python hl_lines="19-24 28" | ||
{!../../../docs_src/additional_responses/tutorial002.py!} | ||
``` | ||
|
||
!!! note | ||
👀 👈 👆 ✔️ 📨 🖼 ⚙️ `FileResponse` 🔗. | ||
|
||
!!! info | ||
🚥 👆 ✔ 🎏 📻 🆎 🎯 👆 `responses` 🔢, FastAPI 🔜 🤔 📨 ✔️ 🎏 📻 🆎 👑 📨 🎓 (🔢 `application/json`). | ||
|
||
✋️ 🚥 👆 ✔️ ✔ 🛃 📨 🎓 ⏮️ `None` 🚮 📻 🆎, FastAPI 🔜 ⚙️ `application/json` 🙆 🌖 📨 👈 ✔️ 👨💼 🏷. | ||
|
||
## 🌀 ℹ | ||
|
||
👆 💪 🌀 📨 ℹ ⚪️➡️ 💗 🥉, 🔌 `response_model`, `status_code`, & `responses` 🔢. | ||
|
||
👆 💪 📣 `response_model`, ⚙️ 🔢 👔 📟 `200` (⚖️ 🛃 1️⃣ 🚥 👆 💪), & ⤴️ 📣 🌖 ℹ 👈 🎏 📨 `responses`, 🔗 🗄 🔗. | ||
|
||
**FastAPI** 🔜 🚧 🌖 ℹ ⚪️➡️ `responses`, & 🌀 ⚫️ ⏮️ 🎻 🔗 ⚪️➡️ 👆 🏷. | ||
|
||
🖼, 👆 💪 📣 📨 ⏮️ 👔 📟 `404` 👈 ⚙️ Pydantic 🏷 & ✔️ 🛃 `description`. | ||
|
||
& 📨 ⏮️ 👔 📟 `200` 👈 ⚙️ 👆 `response_model`, ✋️ 🔌 🛃 `example`: | ||
|
||
```Python hl_lines="20-31" | ||
{!../../../docs_src/additional_responses/tutorial003.py!} | ||
``` | ||
|
||
⚫️ 🔜 🌐 🌀 & 🔌 👆 🗄, & 🎦 🛠️ 🩺: | ||
|
||
<img src="/img/tutorial/additional-responses/image01.png"> | ||
|
||
## 🌀 🔢 📨 & 🛃 🕐 | ||
|
||
👆 💪 💚 ✔️ 🔁 📨 👈 ✔ 📚 *➡ 🛠️*, ✋️ 👆 💚 🌀 👫 ⏮️ 🛃 📨 💚 🔠 *➡ 🛠️*. | ||
|
||
📚 💼, 👆 💪 ⚙️ 🐍 ⚒ "🏗" `dict` ⏮️ `**dict_to_unpack`: | ||
|
||
```Python | ||
old_dict = { | ||
"old key": "old value", | ||
"second old key": "second old value", | ||
} | ||
new_dict = {**old_dict, "new key": "new value"} | ||
``` | ||
|
||
📥, `new_dict` 🔜 🔌 🌐 🔑-💲 👫 ⚪️➡️ `old_dict` ➕ 🆕 🔑-💲 👫: | ||
|
||
```Python | ||
{ | ||
"old key": "old value", | ||
"second old key": "second old value", | ||
"new key": "new value", | ||
} | ||
``` | ||
|
||
👆 💪 ⚙️ 👈 ⚒ 🏤-⚙️ 🔢 📨 👆 *➡ 🛠️* & 🌀 👫 ⏮️ 🌖 🛃 🕐. | ||
|
||
🖼: | ||
|
||
```Python hl_lines="13-17 26" | ||
{!../../../docs_src/additional_responses/tutorial004.py!} | ||
``` | ||
|
||
## 🌖 ℹ 🔃 🗄 📨 | ||
|
||
👀 ⚫️❔ ⚫️❔ 👆 💪 🔌 📨, 👆 💪 ✅ 👉 📄 🗄 🔧: | ||
|
||
* <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#responsesObject" class="external-link" target="_blank">🗄 📨 🎚</a>, ⚫️ 🔌 `Response Object`. | ||
* <a href="https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#responseObject" class="external-link" target="_blank">🗄 📨 🎚</a>, 👆 💪 🔌 🕳 ⚪️➡️ 👉 🔗 🔠 📨 🔘 👆 `responses` 🔢. ✅ `description`, `headers`, `content` (🔘 👉 👈 👆 📣 🎏 🔉 🆎 & 🎻 🔗), & `links`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
# 🌖 👔 📟 | ||
|
||
🔢, **FastAPI** 🔜 📨 📨 ⚙️ `JSONResponse`, 🚮 🎚 👆 📨 ⚪️➡️ 👆 *➡ 🛠️* 🔘 👈 `JSONResponse`. | ||
|
||
⚫️ 🔜 ⚙️ 🔢 👔 📟 ⚖️ 1️⃣ 👆 ⚒ 👆 *➡ 🛠️*. | ||
|
||
## 🌖 👔 📟 | ||
|
||
🚥 👆 💚 📨 🌖 👔 📟 ↖️ ⚪️➡️ 👑 1️⃣, 👆 💪 👈 🛬 `Response` 🔗, 💖 `JSONResponse`, & ⚒ 🌖 👔 📟 🔗. | ||
|
||
🖼, ➡️ 💬 👈 👆 💚 ✔️ *➡ 🛠️* 👈 ✔ ℹ 🏬, & 📨 🇺🇸🔍 👔 📟 2️⃣0️⃣0️⃣ "👌" 🕐❔ 🏆. | ||
|
||
✋️ 👆 💚 ⚫️ 🚫 🆕 🏬. & 🕐❔ 🏬 🚫 🔀 ⏭, ⚫️ ✍ 👫, & 📨 🇺🇸🔍 👔 📟 2️⃣0️⃣1️⃣ "✍". | ||
|
||
🏆 👈, 🗄 `JSONResponse`, & 📨 👆 🎚 📤 🔗, ⚒ `status_code` 👈 👆 💚: | ||
|
||
```Python hl_lines="4 25" | ||
{!../../../docs_src/additional_status_codes/tutorial001.py!} | ||
``` | ||
|
||
!!! warning | ||
🕐❔ 👆 📨 `Response` 🔗, 💖 🖼 🔛, ⚫️ 🔜 📨 🔗. | ||
|
||
⚫️ 🏆 🚫 🎻 ⏮️ 🏷, ♒️. | ||
|
||
⚒ 💭 ⚫️ ✔️ 📊 👆 💚 ⚫️ ✔️, & 👈 💲 ☑ 🎻 (🚥 👆 ⚙️ `JSONResponse`). | ||
|
||
!!! note "📡 ℹ" | ||
👆 💪 ⚙️ `from starlette.responses import JSONResponse`. | ||
|
||
**FastAPI** 🚚 🎏 `starlette.responses` `fastapi.responses` 🏪 👆, 👩💻. ✋️ 🌅 💪 📨 👟 🔗 ⚪️➡️ 💃. 🎏 ⏮️ `status`. | ||
|
||
## 🗄 & 🛠️ 🩺 | ||
|
||
🚥 👆 📨 🌖 👔 📟 & 📨 🔗, 👫 🏆 🚫 🔌 🗄 🔗 (🛠️ 🩺), ↩️ FastAPI 🚫 ✔️ 🌌 💭 ⏪ ⚫️❔ 👆 🚶 📨. | ||
|
||
✋️ 👆 💪 📄 👈 👆 📟, ⚙️: [🌖 📨](additional-responses.md){.internal-link target=_blank}. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,70 @@ | ||
# 🏧 🔗 | ||
|
||
## 🔗 🔗 | ||
|
||
🌐 🔗 👥 ✔️ 👀 🔧 🔢 ⚖️ 🎓. | ||
|
||
✋️ 📤 💪 💼 🌐❔ 👆 💚 💪 ⚒ 🔢 🔛 🔗, 🍵 ✔️ 📣 📚 🎏 🔢 ⚖️ 🎓. | ||
|
||
➡️ 🌈 👈 👥 💚 ✔️ 🔗 👈 ✅ 🚥 🔢 🔢 `q` 🔌 🔧 🎚. | ||
|
||
✋️ 👥 💚 💪 🔗 👈 🔧 🎚. | ||
|
||
## "🇧🇲" 👐 | ||
|
||
🐍 📤 🌌 ⚒ 👐 🎓 "🇧🇲". | ||
|
||
🚫 🎓 ⚫️ (❔ ⏪ 🇧🇲), ✋️ 👐 👈 🎓. | ||
|
||
👈, 👥 📣 👩🔬 `__call__`: | ||
|
||
```Python hl_lines="10" | ||
{!../../../docs_src/dependencies/tutorial011.py!} | ||
``` | ||
|
||
👉 💼, 👉 `__call__` ⚫️❔ **FastAPI** 🔜 ⚙️ ✅ 🌖 🔢 & 🎧-🔗, & 👉 ⚫️❔ 🔜 🤙 🚶♀️ 💲 🔢 👆 *➡ 🛠️ 🔢* ⏪. | ||
|
||
## 🔗 👐 | ||
|
||
& 🔜, 👥 💪 ⚙️ `__init__` 📣 🔢 👐 👈 👥 💪 ⚙️ "🔗" 🔗: | ||
|
||
```Python hl_lines="7" | ||
{!../../../docs_src/dependencies/tutorial011.py!} | ||
``` | ||
|
||
👉 💼, **FastAPI** 🏆 🚫 ⏱ 👆 ⚖️ 💅 🔃 `__init__`, 👥 🔜 ⚙️ ⚫️ 🔗 👆 📟. | ||
|
||
## ✍ 👐 | ||
|
||
👥 💪 ✍ 👐 👉 🎓 ⏮️: | ||
|
||
```Python hl_lines="16" | ||
{!../../../docs_src/dependencies/tutorial011.py!} | ||
``` | ||
|
||
& 👈 🌌 👥 💪 "🔗" 👆 🔗, 👈 🔜 ✔️ `"bar"` 🔘 ⚫️, 🔢 `checker.fixed_content`. | ||
|
||
## ⚙️ 👐 🔗 | ||
|
||
⤴️, 👥 💪 ⚙️ 👉 `checker` `Depends(checker)`, ↩️ `Depends(FixedContentQueryChecker)`, ↩️ 🔗 👐, `checker`, 🚫 🎓 ⚫️. | ||
|
||
& 🕐❔ ❎ 🔗, **FastAPI** 🔜 🤙 👉 `checker` 💖: | ||
|
||
```Python | ||
checker(q="somequery") | ||
``` | ||
|
||
...& 🚶♀️ ⚫️❔ 👈 📨 💲 🔗 👆 *➡ 🛠️ 🔢* 🔢 `fixed_content_included`: | ||
|
||
```Python hl_lines="20" | ||
{!../../../docs_src/dependencies/tutorial011.py!} | ||
``` | ||
|
||
!!! tip | ||
🌐 👉 💪 😑 🎭. & ⚫️ 💪 🚫 📶 🆑 ❔ ⚫️ ⚠. | ||
|
||
👫 🖼 😫 🙅, ✋️ 🎦 ❔ ⚫️ 🌐 👷. | ||
|
||
📃 🔃 💂♂, 📤 🚙 🔢 👈 🛠️ 👉 🎏 🌌. | ||
|
||
🚥 👆 🤔 🌐 👉, 👆 ⏪ 💭 ❔ 👈 🚙 🧰 💂♂ 👷 🔘. |
Oops, something went wrong.