+
+
-
+
+
@@ -117,7 +120,7 @@ If you are building a CLI app to be
## Requirements
-Python 3.7+
+Python 3.8+
FastAPI stands on the shoulders of giants:
@@ -333,7 +336,7 @@ You do that with standard modern Python types.
You don't have to learn a new syntax, the methods or classes of a specific library, etc.
-Just standard **Python 3.7+**.
+Just standard **Python 3.8+**.
For example, for an `int`:
diff --git a/docs/de/docs/features.md b/docs/de/docs/features.md
index f281afd1e..64fa8092d 100644
--- a/docs/de/docs/features.md
+++ b/docs/de/docs/features.md
@@ -25,7 +25,7 @@ Mit einer interaktiven API-Dokumentation und explorativen webbasierten Benutzers
### Nur modernes Python
-Alles basiert auf **Python 3.6 Typ**-Deklarationen (dank Pydantic). Es muss keine neue Syntax gelernt werden, nur standardisiertes modernes Python.
+Alles basiert auf **Python 3.8 Typ**-Deklarationen (dank Pydantic). Es muss keine neue Syntax gelernt werden, nur standardisiertes modernes Python.
diff --git a/docs/em/docs/advanced/extending-openapi.md b/docs/em/docs/advanced/extending-openapi.md
deleted file mode 100644
index 496a8d9de..000000000
--- a/docs/em/docs/advanced/extending-openapi.md
+++ /dev/null
@@ -1,314 +0,0 @@
-# โ ๐
-
-!!! warning
- ๐ ๐ ๐ง โ. ๐ ๐ฒ ๐ช ๐ถ โซ๏ธ.
-
- ๐ฅ ๐ ๐ ๐ฐ - ๐ฉโ๐ป ๐ฆฎ, ๐ ๐ช ๐ฒ ๐ถ ๐ ๐.
-
- ๐ฅ ๐ โช ๐ญ ๐ ๐ ๐ช ๐ ๐ ๐ ๐, ๐ฃ ๐.
-
-๐ค ๐ผ ๐โ ๐ ๐ช ๐ช ๐ ๐ ๐ ๐.
-
-๐ ๐ ๐ ๐ ๐ โ.
-
-## ๐ ๐ ๏ธ
-
-๐ (๐ข) ๐ ๏ธ, โฉ.
-
-`FastAPI` ๐ธ (๐) โ๏ธ `.openapi()` ๐ฉโ๐ฌ ๐ ๐ ๐จ ๐ ๐.
-
-๐ ๐ธ ๐ ๐, *โก ๐ ๏ธ* `/openapi.json` (โ๏ธ โซ๏ธโ ๐ โ ๐ `openapi_url`) ยฎ.
-
-โซ๏ธ ๐จ ๐ป ๐จ โฎ๏ธ ๐ ๐ธ `.openapi()` ๐ฉโ๐ฌ.
-
-๐ข, โซ๏ธโ ๐ฉโ๐ฌ `.openapi()` ๐จ โ
๐ `.openapi_schema` ๐ ๐ฅ โซ๏ธ โ๏ธ ๐ & ๐จ ๐ซ.
-
-๐ฅ โซ๏ธ ๐ซ, โซ๏ธ ๐ ๐ซ โ๏ธ ๐ ๐ข `fastapi.openapi.utils.get_openapi`.
-
-& ๐ ๐ข `get_openapi()` ๐จ ๐ข:
-
-* `title`: ๐ ๐, ๐ฆ ๐ฉบ.
-* `version`: โฌ ๐ ๐ ๏ธ, โ
`2.5.0`.
-* `openapi_version`: โฌ ๐ ๐ง โ๏ธ. ๐ข, โช: `3.0.2`.
-* `description`: ๐ ๐ ๐ ๏ธ.
-* `routes`: ๐ ๐ฃ, ๐ซ ๐ ยฎ *โก ๐ ๏ธ*. ๐ซ โ โช๏ธโก๏ธ `app.routes`.
-
-## ๐ ๐ข
-
-โ๏ธ โน ๐, ๐ ๐ช โ๏ธ ๐ ๐ ๐ข ๐ ๐ ๐ & ๐ ๐ ๐ ๐ ๐ ๐ช.
-
-๐ผ, โก๏ธ ๐ฎ ๐ ๐ โ ๐ ๐ ๐ฑ.
-
-### ๐ **FastAPI**
-
-๐ฅ, โ ๐ ๐ **FastAPI** ๐ธ ๐:
-
-```Python hl_lines="1 4 7-9"
-{!../../../docs_src/extending_openapi/tutorial001.py!}
-```
-
-### ๐ ๐ ๐
-
-โคด๏ธ, โ๏ธ ๐ ๐ ๐ข ๐ ๐ ๐, ๐ `custom_openapi()` ๐ข:
-
-```Python hl_lines="2 15-20"
-{!../../../docs_src/extending_openapi/tutorial001.py!}
-```
-
-### ๐ ๐ ๐
-
-๐ ๐ ๐ช ๐ฎ ๐ โ, โ ๐ `x-logo` `info` "๐" ๐ ๐:
-
-```Python hl_lines="21-23"
-{!../../../docs_src/extending_openapi/tutorial001.py!}
-```
-
-### ๐พ ๐ ๐
-
-๐ ๐ช โ๏ธ ๐ `.openapi_schema` "๐พ", ๐ช ๐ ๐ ๐.
-
-๐ ๐, ๐ ๐ธ ๐ ๐ซ โ๏ธ ๐ ๐ ๐ ๐ฐ ๐ฉโ๐ป ๐ ๐ ๐ ๏ธ ๐ฉบ.
-
-โซ๏ธ ๐ ๐ ๐ด ๐, & โคด๏ธ ๐ ๐พ ๐ ๐ โ๏ธ โญ ๐จ.
-
-```Python hl_lines="13-14 24-25"
-{!../../../docs_src/extending_openapi/tutorial001.py!}
-```
-
-### ๐ ๐ฉโ๐ฌ
-
-๐ ๐ ๐ช โ `.openapi()` ๐ฉโ๐ฌ โฎ๏ธ ๐ ๐ ๐ข.
-
-```Python hl_lines="28"
-{!../../../docs_src/extending_openapi/tutorial001.py!}
-```
-
-### โ
โซ๏ธ
-
-๐ ๐ ๐ถ http://127.0.0.1:8000/redoc ๐ ๐ ๐ ๐ ๐ โ๏ธ ๐ ๐ ๐ฑ (๐ ๐ผ, **FastAPI**'โ ๐ฑ):
-
-
-
-## ๐ค-๐ธ ๐ธ & ๐ ๐ฉบ
-
-๐ ๏ธ ๐ฉบ โ๏ธ **๐ฆ ๐** & **๐**, & ๐ ๐ ๐ช ๐ธ & ๐ ๐.
-
-๐ข, ๐ ๐ ๐ฆ โช๏ธโก๏ธ ๐ฒ.
-
-โ๏ธ โซ๏ธ ๐ช ๐ โซ๏ธ, ๐ ๐ช โ ๐ฏ ๐ฒ, โ๏ธ ๐ฆ ๐ ๐.
-
-๐ โ , ๐ผ, ๐ฅ ๐ ๐ช ๐ ๐ฑ ๐ง ๐ท โช ๐ฑ, ๐ต ๐ ๐ธ ๐, โ๏ธ ๐ง๐ฟ ๐ธ.
-
-๐ฅ ๐ ๐ ๐ โ ๐ฆ ๐ ๐ ๐, ๐ FastAPI ๐ฑ, & ๐ ๐ฉบ โ๏ธ ๐ซ.
-
-### ๐ ๐ ๐
-
-โก๏ธ ๐ฌ ๐ ๐ ๐ ๐ ๐ ๐ ๐:
-
-```
-.
-โโโ app
-โ โโโ __init__.py
-โ โโโ main.py
-```
-
-๐ โ ๐ ๐ช ๐ ๐ป ๐.
-
-๐ ๐ ๐ ๐ ๐ช ๐ ๐ ๐:
-
-```
-.
-โโโ app
-โย ย โโโ __init__.py
-โย ย โโโ main.py
-โโโ static/
-```
-
-### โฌ ๐
-
-โฌ ๐ป ๐ ๐ช ๐ฉบ & ๐ฎ ๐ซ ๐ ๐ `static/` ๐.
-
-๐ ๐ช ๐ฒ โถ๏ธ๏ธ-๐ ๐ ๐ & ๐ ๐ ๐ `Save link as...`.
-
-**๐ฆ ๐** โ๏ธ ๐:
-
-* `swagger-ui-bundle.js`
-* `swagger-ui.css`
-
-& **๐** โ๏ธ ๐:
-
-* `redoc.standalone.js`
-
-โฎ๏ธ ๐, ๐ ๐ ๐ ๐ช ๐ ๐:
-
-```
-.
-โโโ app
-โย ย โโโ __init__.py
-โย ย โโโ main.py
-โโโ static
- โโโ redoc.standalone.js
- โโโ swagger-ui-bundle.js
- โโโ swagger-ui.css
-```
-
-### ๐ฆ ๐ป ๐
-
-* ๐ `StaticFiles`.
-* "๐ป" `StaticFiles()` ๐ ๐ฏ โก.
-
-```Python hl_lines="7 11"
-{!../../../docs_src/extending_openapi/tutorial002.py!}
-```
-
-### ๐ฏ ๐ป ๐
-
-โถ๏ธ ๐ ๐ธ & ๐ถ http://127.0.0.1:8000/static/redoc.standalone.js.
-
-๐ ๐ ๐ ๐ถ ๐ ๐ธ ๐ **๐**.
-
-โซ๏ธ ๐ช โถ๏ธ โฎ๏ธ ๐ณ ๐:
-
-```JavaScript
-/*!
- * ReDoc - OpenAPI/Swagger-generated API Reference Documentation
- * -------------------------------------------------------------
- * Version: "2.0.0-rc.18"
- * Repo: https://github.com/Redocly/redoc
- */
-!function(e,t){"object"==typeof exports&&"object"==typeof m
-
-...
-```
-
-๐ โ ๐ ๐ ๐โโ ๐ช ๐ฆ ๐ป ๐ โช๏ธโก๏ธ ๐ ๐ฑ, & ๐ ๐ ๐ฅ ๐ป ๐ ๐ฉบ โ ๐ฅ.
-
-๐ ๐ฅ ๐ช ๐ ๐ฑ โ๏ธ ๐ ๐ป ๐ ๐ฉบ.
-
-### โ ๐ง ๐ฉบ
-
-๐ฅ ๐ โ ๐ง ๐ฉบ, ๐ โ๏ธ ๐ฒ ๐ข.
-
-โ ๐ซ, โ ๐ซ ๐ `None` ๐โ ๐ ๐ `FastAPI` ๐ฑ:
-
-```Python hl_lines="9"
-{!../../../docs_src/extending_openapi/tutorial002.py!}
-```
-
-### ๐ ๐ ๐ฉบ
-
-๐ ๐ ๐ช โ *โก ๐ ๏ธ* ๐ ๐ฉบ.
-
-๐ ๐ช ๐ค-โ๏ธ FastAPI ๐ ๐ข โ ๐ธ ๐ ๐ฉบ, & ๐ถโโ๏ธ ๐ซ ๐ช โ:
-
-* `openapi_url`: ๐ ๐โ ๐ธ ๐ ๐ฉบ ๐ช ๐ค ๐ ๐ ๐ ๐ ๏ธ. ๐ ๐ช โ๏ธ ๐ฅ ๐ข `app.openapi_url`.
-* `title`: ๐ ๐ ๐ ๏ธ.
-* `oauth2_redirect_url`: ๐ ๐ช โ๏ธ `app.swagger_ui_oauth2_redirect_url` ๐ฅ โ๏ธ ๐ข.
-* `swagger_js_url`: ๐ ๐โ ๐ธ ๐ ๐ฆ ๐ ๐ฉบ ๐ช ๐ค **๐ธ** ๐. ๐ 1๏ธโฃ ๐ ๐ ๐ ๐ฑ ๐ ๐ฆ.
-* `swagger_css_url`: ๐ ๐โ ๐ธ ๐ ๐ฆ ๐ ๐ฉบ ๐ช ๐ค **๐** ๐. ๐ 1๏ธโฃ ๐ ๐ ๐ ๐ฑ ๐ ๐ฆ.
-
-& โก ๐...
-
-```Python hl_lines="2-6 14-22 25-27 30-36"
-{!../../../docs_src/extending_openapi/tutorial002.py!}
-```
-
-!!! tip
- *โก ๐ ๏ธ* `swagger_ui_redirect` ๐ฉโ๐ ๐โ ๐ โ๏ธ Oauth2๏ธโฃ.
-
- ๐ฅ ๐ ๐ ๏ธ ๐ ๐ ๏ธ โฎ๏ธ Oauth2๏ธโฃ ๐โ๐ฆบ, ๐ ๐ ๐ช ๐ & ๐ ๐ ๐ ๏ธ ๐ฉบ โฎ๏ธ ๐ ๐. & ๐ โฎ๏ธ โซ๏ธ โ๏ธ ๐ฐ Oauth2๏ธโฃ ๐ค.
-
- ๐ฆ ๐ ๐ ๐ต โซ๏ธ โ
๐ ๐, โ๏ธ โซ๏ธ ๐ช ๐ "โ" ๐ฉโ๐.
-
-### โ *โก ๐ ๏ธ* ๐ฏ โซ๏ธ
-
-๐, ๐ช ๐ฏ ๐ ๐ ๐ท, โ *โก ๐ ๏ธ*:
-
-```Python hl_lines="39-41"
-{!../../../docs_src/extending_openapi/tutorial002.py!}
-```
-
-### ๐ฏ โซ๏ธ
-
-๐, ๐ ๐ ๐ช ๐ ๐ ๐ป, ๐ถ ๐ ๐ฉบ http://127.0.0.1:8000/docs, & ๐ ๐.
-
-& ๐ต ๐ธ, ๐ ๐ ๐ช ๐ ๐ฉบ ๐ ๐ ๏ธ & ๐ โฎ๏ธ โซ๏ธ.
-
-## ๐ ๏ธ ๐ฆ ๐
-
-๐ ๐ช ๐ โ ๐ฆ ๐ ๐ข.
-
-๐ ๐ซ, ๐ถโโ๏ธ `swagger_ui_parameters` โ ๐โ ๐ `FastAPI()` ๐ฑ ๐ โ๏ธ `get_swagger_ui_html()` ๐ข.
-
-`swagger_ui_parameters` ๐จ ๐ โฎ๏ธ ๐ณ ๐ถโโ๏ธ ๐ฆ ๐ ๐.
-
-FastAPI ๐ ๐ณ **๐ป** โ ๐ซ ๐ โฎ๏ธ ๐ธ, ๐ โซ๏ธโ ๐ฆ ๐ ๐ช.
-
-### โ โ ๐ฆ
-
-๐ผ, ๐ ๐ช โ โ ๐ฆ ๐ฆ ๐.
-
-๐ต ๐ โ, โ ๐ฆ ๐ ๏ธ ๐ข:
-
-
-
-โ๏ธ ๐ ๐ช โ โซ๏ธ โ `syntaxHighlight` `False`:
-
-```Python hl_lines="3"
-{!../../../docs_src/extending_openapi/tutorial003.py!}
-```
-
-...& โคด๏ธ ๐ฆ ๐ ๐ ๐ซ ๐ฆ โ ๐ฆ ๐ซ๐:
-
-
-
-### ๐ ๐ข
-
-๐ ๐ ๐ ๐ช โ โ ๐ฆ ๐ข โฎ๏ธ ๐ `"syntaxHighlight.theme"` (๐ ๐ โซ๏ธ โ๏ธ โฃ ๐):
-
-```Python hl_lines="3"
-{!../../../docs_src/extending_openapi/tutorial004.py!}
-```
-
-๐ ๐ณ ๐ ๐ โ ๐ฆ ๐จ ๐ข:
-
-
-
-### ๐ ๐ข ๐ฆ ๐ ๐ข
-
-FastAPI ๐ ๐ข ๐ณ ๐ข โ ๐
โ๏ธ ๐ผ.
-
-โซ๏ธ ๐ ๐ซ ๐ข ๐ณ:
-
-```Python
-{!../../../fastapi/openapi/docs.py[ln:7-13]!}
-```
-
-๐ ๐ช ๐ ๐ ๐ซ โ ๐ ๐ฒ โ `swagger_ui_parameters`.
-
-๐ผ, โ `deepLinking` ๐ ๐ช ๐ถโโ๏ธ ๐ โ `swagger_ui_parameters`:
-
-```Python hl_lines="3"
-{!../../../docs_src/extending_openapi/tutorial005.py!}
-```
-
-### ๐ ๐ฆ ๐ ๐ข
-
-๐ ๐ ๐ ๐ช ๐ณ ๐ ๐ช โ๏ธ, โ ๐ ๐ฉบ ๐ฆ ๐ ๐ข.
-
-### ๐ธ-๐ด โ
-
-๐ฆ ๐ โ ๐ ๐ณ **๐ธ-๐ด** ๐ (๐ผ, ๐ธ ๐ข).
-
-FastAPI ๐ ๐ซ ๐ธ-๐ด `presets` โ:
-
-```JavaScript
-presets: [
- SwaggerUIBundle.presets.apis,
- SwaggerUIBundle.SwaggerUIStandalonePreset
-]
-```
-
-๐ซ **๐ธ** ๐, ๐ซ ๐ป, ๐ ๐ช ๐ซ ๐ถโโ๏ธ ๐ซ โช๏ธโก๏ธ ๐ ๐ ๐.
-
-๐ฅ ๐ ๐ช โ๏ธ ๐ธ-๐ด ๐ณ ๐ ๐, ๐ ๐ช โ๏ธ 1๏ธโฃ ๐ฉโ๐ฌ ๐. ๐ ๐ ๐ฆ ๐ *โก ๐ ๏ธ* & โ โ ๐ ๐ธ ๐ ๐ช.
diff --git a/docs/em/docs/deployment/concepts.md b/docs/em/docs/deployment/concepts.md
index 8ce775411..162b68615 100644
--- a/docs/em/docs/deployment/concepts.md
+++ b/docs/em/docs/deployment/concepts.md
@@ -43,7 +43,7 @@
* โฎ๏ธ ๐ข ๐ฆฒ ๐ Certbot ๐ ๐
* โณ
* โฎ๏ธ ๐ข ๐ฆฒ ๐ Certbot ๐ ๐
-* Kubernete โฎ๏ธ ๐ง ๐น ๐ ๐
+* Kubernetes โฎ๏ธ ๐ง ๐น ๐ ๐
* โฎ๏ธ ๐ข ๐ฆฒ ๐ ๐-๐จโ๐ผ ๐ ๐
* ๐ต ๐ โ ๐โ๐ฆบ ๐ ๐ซ ๐โ๐ฆบ (โ ๐ ๐ถ)
@@ -115,7 +115,7 @@
๐ผ ๐งฐ ๐ ๐ช ๐ ๐จโ๐ญ:
* โ
-* Kubernete
+* Kubernetes
* โ โ
* โ ๐ ๐ณ
* โณ
@@ -165,7 +165,7 @@
๐ผ, ๐ ๐ช ๐ต:
* โ
-* Kubernete
+* Kubernetes
* โ โ
* โ ๐ ๐ณ
* โณ
@@ -233,15 +233,15 @@
* ๐ ๐ **๐ ๏ธ ๐จโ๐ผ** ๐ ๐ **๐ข** & **โด**, ๐งฌ ๐ โ๏ธ **๐ Uvicorn ๐จโ๐ญ ๐ ๏ธ**
* **Uvicorn** ๐ ๏ธ **Uvicorn ๐จโ๐ญ**
* 1๏ธโฃ Uvicorn **๐ ๏ธ ๐จโ๐ผ** ๐ ๐ ๐ **๐ข** & **โด**, & โซ๏ธ ๐ โถ๏ธ **๐ Uvicorn ๐จโ๐ญ ๐ ๏ธ**
-* **Kubernete** & ๐ ๐ **๐ฆ โ๏ธ**
+* **Kubernetes** & ๐ ๐ **๐ฆ โ๏ธ**
* ๐ณ **โ** ๐งฝ ๐ ๐ ๐ **๐ข** & **โด**. ๐งฌ ๐ โ๏ธ **๐ ๐ฆ**, ๐ โฎ๏ธ **1๏ธโฃ Uvicorn ๐ ๏ธ** ๐โโ
* **โ ๐โ๐ฆบ** ๐ ๐ต ๐ ๐
* โ ๐โ๐ฆบ ๐ ๐ฒ **๐ต ๐งฌ ๐**. โซ๏ธ ๐ ๐ฒ โก๏ธ ๐ ๐ฌ **๐ ๏ธ ๐**, โ๏ธ **๐ฆ ๐ผ** โ๏ธ, ๐ ๐ผ, โซ๏ธ ๐ ๐
๐ฒ **๐ Uvicorn ๐ ๏ธ**, & โ ๐โ๐ฆบ ๐ ๐ ๐ โซ๏ธ.
!!! tip
- ๐ซ ๐ ๐ฅ ๐ซ ๐ฌ ๐ **๐ฆ**, โ, โ๏ธ Kubernete ๐ซ โ ๐ ๐.
+ ๐ซ ๐ ๐ฅ ๐ซ ๐ฌ ๐ **๐ฆ**, โ, โ๏ธ Kubernetes ๐ซ โ ๐ ๐.
- ๐ค ๐ ๐ฌ ๐ ๐
๐ ๐ฆ ๐ผ, โ, Kubernete, โ๏ธ. ๐ฎ ๐: [FastAPI ๐ฆ - โ](./docker.md){.internal-link target=_blank}.
+ ๐ค ๐ ๐ฌ ๐ ๐
๐ ๐ฆ ๐ผ, โ, Kubernetes, โ๏ธ. ๐ฎ ๐: [FastAPI ๐ฆ - โ](./docker.md){.internal-link target=_blank}.
## โฎ๏ธ ๐ โญ โถ๏ธ
@@ -268,7 +268,7 @@
๐ฅ ๐ช ๐ญ:
-* "๐ ๐ฆ" Kubernete ๐ ๐ โญ ๐ ๐ฑ ๐ฆ
+* "๐ ๐ฆ" Kubernetes ๐ ๐ โญ ๐ ๐ฑ ๐ฆ
* ๐ โ ๐ ๐ โฎ๏ธ ๐ & โคด๏ธ โถ๏ธ ๐ ๐ธ
* ๐ ๐ ๐ช ๐ โถ๏ธ/โ *๐* ๐ โ, ๐ โ, โ๏ธ.
diff --git a/docs/em/docs/deployment/deta.md b/docs/em/docs/deployment/deta.md
deleted file mode 100644
index 89b6c4bdb..000000000
--- a/docs/em/docs/deployment/deta.md
+++ /dev/null
@@ -1,258 +0,0 @@
-# ๐ ๏ธ FastAPI ๐ ๐ช
-
-๐ ๐ ๐ ๐ ๐ก โ ๐ช ๐ ๏ธ **FastAPI** ๐ธ ๐ ๐ช โ๏ธ ๐ ๐. ๐ถ
-
-โซ๏ธ ๐ โ ๐ ๐ **1๏ธโฃ0๏ธโฃ โฒ**.
-
-!!! info
- ๐ช **FastAPI** ๐ฐ. ๐ถ
-
-## ๐ฐ **FastAPI** ๐ฑ
-
-* โ ๐ ๐ ๐ฑ, ๐ผ, `./fastapideta/` & โ ๐ โซ๏ธ.
-
-### FastAPI ๐
-
-* โ `main.py` ๐ โฎ๏ธ:
-
-```Python
-from fastapi import FastAPI
-
-app = FastAPI()
-
-
-@app.get("/")
-def read_root():
- return {"Hello": "World"}
-
-
-@app.get("/items/{item_id}")
-def read_item(item_id: int):
- return {"item_id": item_id}
-```
-
-### ๐
-
-๐, ๐ ๐ โ ๐ `requirements.txt` โฎ๏ธ:
-
-```text
-fastapi
-```
-
-!!! tip
- ๐ ๐ซ ๐ช โ Uvicorn ๐ ๏ธ ๐ ๐ช, ๐ ๐ ๐ ๐ฒ ๐ โ โซ๏ธ ๐ ๐ฏ ๐ ๐ฑ.
-
-### ๐ ๐
-
-๐ ๐ ๐ โ๏ธ 1๏ธโฃ ๐ `./fastapideta/` โฎ๏ธ 2๏ธโฃ ๐:
-
-```
-.
-โโโ main.py
-โโโ requirements.txt
-```
-
-## โ ๐ ๐ช ๐ง
-
-๐ โ ๐ ๐ง ๐ ๐ช, ๐ ๐ช ๐ง & ๐.
-
-๐ ๐ซ ๐ช ๐ณ.
-
-## โ โณ
-
-๐ ๐ โ๏ธ ๐ ๐ง, โ ๐ช โณ:
-
-=== "๐พ, ๐ธ๐ป"
-
- 
-
-## ๐ ๏ธ ๐ข ๐
-
-๐ข, ๐ช ๐ ๐ต ๐ค โ๏ธ ๐ช ๐ ๐ง.
-
-โ๏ธ ๐ ๐ ๐, ๐ ๐ช โ โซ๏ธ ๐ข โฎ๏ธ:
-
-
-
-## ๐ก ๐
-
-โ, ๐ ๐ ๐ฒ ๐ ๐ช ๐ฝ ๐ ๐ฑ ๐ ๐ ๐ฃ ๐ ๐ฐ. ๐ ๐ ๐ช โ๏ธ ๐ช ๐งข, โซ๏ธ โ๏ธ ๐ **๐ ๐**.
-
-๐ ๐ช โ ๐
๐ช ๐ฉบ.
-
-## ๐ ๏ธ ๐ง
-
-๐ ๐ ๐ง ๐ฅ ๐ฌ [๐ ๏ธ ๐ง](./concepts.md){.internal-link target=_blank}, ๐ฅ โ ๐ ๐ซ ๐ ๐ต โฎ๏ธ ๐ช:
-
-* **๐บ๐ธ๐**: ๐ต ๐ช, ๐ซ ๐ ๐ค ๐ ๐ & ๐ต ๐บ๐ธ๐ ๐.
-* **๐โโ ๐ ๐ด**: ๐ต ๐ช, ๐ ๐ซ ๐โ๐ฆบ.
-* **โ**: ๐ต ๐ช, ๐ ๐ซ ๐โ๐ฆบ.
-* **๐งฌ**: ๐ต ๐ช, ๐ ๐ซ ๐โ๐ฆบ.
-* **๐พ**: ๐ ๐ ๐ช, ๐ ๐ช ๐ง ๐ซ ๐ โซ๏ธ.
-* **โฎ๏ธ ๐ โญ โถ๏ธ**: ๐ซ ๐ ๐โ๐ฆบ, ๐ ๐ช โ โซ๏ธ ๐ท โฎ๏ธ ๐ซ ๐พ โ๏ธ โ๏ธ ๐ โ.
-
-!!! note
- ๐ช ๐ง โ โซ๏ธ โฉ (& ๐) ๐ ๏ธ ๐
๐ธ ๐.
-
- โซ๏ธ ๐ช ๐ ๐ โ๏ธ ๐ผ, โ๏ธ ๐ ๐ฐ, โซ๏ธ ๐ซ ๐โ๐ฆบ ๐, ๐ โ๏ธ ๐ข ๐ฝ (โ๏ธ โช๏ธโก๏ธ ๐ช ๐ โ ๐ฝ โ๏ธ), ๐ ๐น ๐ฐ, โ๏ธ.
-
- ๐ ๐ช โ ๐
โน ๐ช ๐ฉบ ๐ ๐ฅ โซ๏ธ โถ๏ธ๏ธ โ ๐.
diff --git a/docs/em/docs/deployment/docker.md b/docs/em/docs/deployment/docker.md
index 51ece5599..f28735ed7 100644
--- a/docs/em/docs/deployment/docker.md
+++ b/docs/em/docs/deployment/docker.md
@@ -74,7 +74,7 @@ CMD ["uvicorn", "app.main:app", "--host", "0.0.0.0", "--port", "80"]
, ๐ ๐ ๐ **๐ ๐ฆ** โฎ๏ธ ๐ ๐, ๐ ๐ฝ, ๐ ๐ธ, ๐ธ ๐ฝ โฎ๏ธ ๐ฅ ๐ธ ๐ธ, & ๐ ๐ซ ๐ฏโโ๏ธ ๐จ ๐ซ ๐ ๐ธ.
-๐ ๐ฆ ๐งพ โ๏ธ (๐ โ โ๏ธ Kubernete) โ๏ธ ๐ซ ๐ธ โ ๐ ๏ธ ๐ ๐ซ.
+๐ ๐ฆ ๐งพ โ๏ธ (๐ โ โ๏ธ Kubernetes) โ๏ธ ๐ซ ๐ธ โ ๐ ๏ธ ๐ ๐ซ.
## ๐ฆ & ๐ ๏ธ
@@ -96,7 +96,7 @@ CMD ["uvicorn", "app.main:app", "--host", "0.0.0.0", "--port", "80"]
๐ โซ๏ธโ ๐ ๐ ๐ **๐ ๐ผ**, ๐ผ:
-* โ๏ธ **Kubernete** โ๏ธ ๐ ๐งฐ
+* โ๏ธ **Kubernetes** โ๏ธ ๐ ๐งฐ
* ๐โ ๐โโ ๐ **๐ ๐ฒ**
* โ๏ธ โ ๐โ๐ฆบ ๐ ๐ ๐ ๐ฆ ๐ผ ๐, โ๏ธ.
@@ -395,7 +395,7 @@ CMD ["uvicorn", "main:app", "--host", "0.0.0.0", "--port", "80"]
โซ๏ธ ๐ช โ1๏ธโฃ ๐ฆ, ๐ผ โฎ๏ธ Traefik, ๐ **๐บ๐ธ๐** & **๐ง** ๐ ๏ธ **๐**.
!!! tip
- Traefik โ๏ธ ๐ ๏ธ โฎ๏ธ โ, Kubernete, & ๐, โซ๏ธ ๐ถ โฉ โ ๐ & ๐ ๐บ๐ธ๐ ๐ ๐ฆ โฎ๏ธ โซ๏ธ.
+ Traefik โ๏ธ ๐ ๏ธ โฎ๏ธ โ, Kubernetes, & ๐, โซ๏ธ ๐ถ โฉ โ ๐ & ๐ ๐บ๐ธ๐ ๐ ๐ฆ โฎ๏ธ โซ๏ธ.
๐, ๐บ๐ธ๐ ๐ช ๐ต โ ๐โ๐ฆบ 1๏ธโฃ ๐ซ ๐โ๐ฆบ (โช ๐ ๐ธ ๐ฆ).
@@ -403,7 +403,7 @@ CMD ["uvicorn", "main:app", "--host", "0.0.0.0", "--port", "80"]
๐ค ๐ โ1๏ธโฃ ๐งฐ ๐ **โถ๏ธ & ๐โโ** ๐ ๐ฆ.
-โซ๏ธ ๐ช **โ** ๐, **โ โ**, **Kubernete**, **โ ๐โ๐ฆบ**, โ๏ธ.
+โซ๏ธ ๐ช **โ** ๐, **โ โ**, **Kubernetes**, **โ ๐โ๐ฆบ**, โ๏ธ.
๐
(โ๏ธ ๐) ๐ผ, ๐ค ๐
๐ ๐ ๏ธ ๐ ๐ฆ ๐ ๐ด & ๐ ๏ธ โ ๐ โ. ๐ผ, โ, โซ๏ธ ๐ โธ ๐ `--restart`.
@@ -413,7 +413,7 @@ CMD ["uvicorn", "main:app", "--host", "0.0.0.0", "--port", "80"]
๐ฅ ๐ โ๏ธ ๐ ๐ฐ โฎ๏ธ **โ**, โ ๐ ๐ณ, ๐, โ๏ธ โ1๏ธโฃ ๐ ๐ โ๏ธ ๐ ๏ธ ๐ ๐ฆ ๐ ๐ ๐ฐ, โคด๏ธ ๐ ๐ ๐ฒ ๐ **๐ต ๐งฌ** **๐ ๐** โฉ๏ธ โ๏ธ **๐ ๏ธ ๐จโ๐ผ** (๐ ๐ โฎ๏ธ ๐จโ๐ญ) ๐ ๐ฆ.
-1๏ธโฃ ๐ ๐ ๐ฆ ๐งพ โ๏ธ ๐ Kubernete ๐ โ๏ธ ๐ ๏ธ ๐ ๐ **๐งฌ ๐ฆ** โช ๐ **๐ โ** ๐จ ๐จ. ๐ **๐ ๐**.
+1๏ธโฃ ๐ ๐ ๐ฆ ๐งพ โ๏ธ ๐ Kubernetes ๐ โ๏ธ ๐ ๏ธ ๐ ๐ **๐งฌ ๐ฆ** โช ๐ **๐ โ** ๐จ ๐จ. ๐ **๐ ๐**.
๐ ๐ผ, ๐ ๐ ๐ฒ ๐ ๐ **โ ๐ผ โช๏ธโก๏ธ ๐** [๐ฌ ๐](#dockerfile), โ ๐ ๐, & ๐โโ **๐ Uvicorn ๐ ๏ธ** โฉ๏ธ ๐โโ ๐ณ ๐ ๐ โฎ๏ธ Uvicorn ๐จโ๐ญ.
@@ -430,7 +430,7 @@ CMD ["uvicorn", "main:app", "--host", "0.0.0.0", "--port", "80"]
### 1๏ธโฃ ๐ โ - ๐ ๐จโ๐ญ ๐ฆ
-๐โ ๐ท โฎ๏ธ **Kubernete** โ๏ธ ๐ ๐ ๐ฆ ๐งพ โ๏ธ, โ๏ธ ๐ซ ๐ ๐ธ ๐ ๏ธ ๐ โ ๐ **๐ โ** ๐ ๐ ๐ ๐ **โด** ๐ถ ๐ป (๐จ) ๐ฒ **๐ ๐ฆ** ๐ ๐ ๐ฑ.
+๐โ ๐ท โฎ๏ธ **Kubernetes** โ๏ธ ๐ ๐ ๐ฆ ๐งพ โ๏ธ, โ๏ธ ๐ซ ๐ ๐ธ ๐ ๏ธ ๐ โ ๐ **๐ โ** ๐ ๐ ๐ ๐ **โด** ๐ถ ๐ป (๐จ) ๐ฒ **๐ ๐ฆ** ๐ ๐ ๐ฑ.
๐ ๐ซ ๐ฆ ๐โโ ๐ ๐ฑ ๐ ๐ โ๏ธ **1๏ธโฃ ๐ ๏ธ** (โ
Uvicorn ๐ ๏ธ ๐ ๐ FastAPI ๐ธ). ๐ซ ๐ ๐ **๐ ๐ฆ**, ๐โโ ๐ ๐, โ๏ธ ๐ โฎ๏ธ ๐ฎ ๐ ๐ ๏ธ, ๐พ, โ๏ธ. ๐ ๐ ๐ ๐ โ ๐ **๐ ๏ธ** **๐ ๐** ๐ฝ, โ๏ธ **๐ ๐ฐ**.
@@ -489,7 +489,7 @@ CMD ["uvicorn", "main:app", "--host", "0.0.0.0", "--port", "80"]
๐ฅ ๐ ๐ **๐ ๐ ๏ธ ๐ ๐ฆ** ๐ ๐ โ๏ธ ๐
โ๏ธ ๐ ๐-๐ฌ, โ, & ๐ ๐ธ ๐พ ๐ด ๐ ๐ ๐ฆ (๐
๐ 1๏ธโฃ ๐ฅ ๐ซ ๐).
-& โคด๏ธ ๐ ๐ช โ ๐ ๐ ๐พ ๐ & ๐ ๐ ๐ณ ๐ ๐ฆ ๐งพ โ๏ธ (๐ผ **Kubernete**). ๐ ๐ โซ๏ธ ๐ ๐ช **๐ ๐ฆ** **๐ช ๐ฐ** โ ๐ ๐ง ๐ธ ๐พ ๐ช ๐ซ, & ๐ธ ๐ช ๐ฐ ๐.
+& โคด๏ธ ๐ ๐ช โ ๐ ๐ ๐พ ๐ & ๐ ๐ ๐ณ ๐ ๐ฆ ๐งพ โ๏ธ (๐ผ **Kubernetes**). ๐ ๐ โซ๏ธ ๐ ๐ช **๐ ๐ฆ** **๐ช ๐ฐ** โ ๐ ๐ง ๐ธ ๐พ ๐ช ๐ซ, & ๐ธ ๐ช ๐ฐ ๐.
๐ฅ ๐ ๐ธ **๐
**, ๐ ๐ ๐ฒ **๐ซ โ **, & ๐ ๐ช ๐ซ ๐ช โ ๐๏ธ ๐พ ๐. โ๏ธ ๐ฅ ๐ **โ๏ธ ๐ ๐พ** (๐ผ โฎ๏ธ **๐ฐ ๐ซ** ๐ท), ๐ ๐ โ
โ ๐
๐พ ๐ ๐ฉ & ๐ **๐ข ๐ฆ** ๐ ๐ **๐ ๐ฐ** (& ๐ฒ ๐ฎ ๐ ๐ฐ ๐ ๐).
@@ -497,14 +497,14 @@ CMD ["uvicorn", "main:app", "--host", "0.0.0.0", "--port", "80"]
## โฎ๏ธ ๐ โญ โถ๏ธ & ๐ฆ
-๐ฅ ๐ โ๏ธ ๐ฆ (โ
โ, Kubernete), โคด๏ธ ๐ค 2๏ธโฃ ๐ ๐ฏ ๐ ๐ช โ๏ธ.
+๐ฅ ๐ โ๏ธ ๐ฆ (โ
โ, Kubernetes), โคด๏ธ ๐ค 2๏ธโฃ ๐ ๐ฏ ๐ ๐ช โ๏ธ.
### ๐ ๐ฆ
-๐ฅ ๐ โ๏ธ **๐ ๐ฆ**, ๐ฒ ๐ 1๏ธโฃ ๐ **๐ ๐ ๏ธ** (๐ผ, **Kubernete** ๐), โคด๏ธ ๐ ๐ ๐ฒ ๐ โ๏ธ **๐ ๐ฆ** ๐จ ๐ท **โฎ๏ธ ๐ถ** ๐ ๐ฆ, ๐ ๐ ๐ ๏ธ, **โญ** ๐ ๐ ๐จโ๐ญ ๐ฆ.
+๐ฅ ๐ โ๏ธ **๐ ๐ฆ**, ๐ฒ ๐ 1๏ธโฃ ๐ **๐ ๐ ๏ธ** (๐ผ, **Kubernetes** ๐), โคด๏ธ ๐ ๐ ๐ฒ ๐ โ๏ธ **๐ ๐ฆ** ๐จ ๐ท **โฎ๏ธ ๐ถ** ๐ ๐ฆ, ๐ ๐ ๐ ๏ธ, **โญ** ๐ ๐ ๐จโ๐ญ ๐ฆ.
!!! info
- ๐ฅ ๐ โ๏ธ Kubernete, ๐ ๐ ๐ฒ ๐ ๐ฆ.
+ ๐ฅ ๐ โ๏ธ Kubernetes, ๐ ๐ ๐ฒ ๐ ๐ฆ.
๐ฅ ๐ โ๏ธ ๐ผ ๐ค ๐
โโ โ ๐โโ ๐ โฎ๏ธ ๐ถ **๐ ๐ฐ ๐** (๐ผ ๐ฅ ๐ ๐ซ ๐ ๐ฝ ๐ ๏ธ, โ๏ธ โ
๐ฅ ๐ฝ ๐), โคด๏ธ ๐ ๐ช ๐ฎ ๐ซ ๐ ๐ฆ โถ๏ธ๏ธ โญ โถ๏ธ ๐ ๐ ๏ธ.
@@ -574,7 +574,7 @@ COPY ./app /app/app
### ๐โ โ๏ธ
-๐ ๐ ๐ฒ **๐ซ** โ๏ธ ๐ ๐ ๐งข ๐ผ (โ๏ธ ๐ ๐ ๐ 1๏ธโฃ) ๐ฅ ๐ โ๏ธ **Kubernete** (โ๏ธ ๐) & ๐ โช โ **๐งฌ** ๐ ๐, โฎ๏ธ ๐ **๐ฆ**. ๐ ๐ผ, ๐ ๐ ๐ **๐ ๐ผ โช๏ธโก๏ธ ๐** ๐ฌ ๐: [๐ โ ๐ผ FastAPI](#build-a-docker-image-for-fastapi).
+๐ ๐ ๐ฒ **๐ซ** โ๏ธ ๐ ๐ ๐งข ๐ผ (โ๏ธ ๐ ๐ ๐ 1๏ธโฃ) ๐ฅ ๐ โ๏ธ **Kubernetes** (โ๏ธ ๐) & ๐ โช โ **๐งฌ** ๐ ๐, โฎ๏ธ ๐ **๐ฆ**. ๐ ๐ผ, ๐ ๐ ๐ **๐ ๐ผ โช๏ธโก๏ธ ๐** ๐ฌ ๐: [๐ โ ๐ผ FastAPI](#build-a-docker-image-for-fastapi).
๐ ๐ผ ๐ โ โด๏ธ ๐ ๐ผ ๐ฌ ๐ [๐ฆ โฎ๏ธ ๐ ๐ ๏ธ & ๐ ๐ผ](#containers-with-multiple-processes-and-special-cases). ๐ผ, ๐ฅ ๐ ๐ธ **๐
๐ฅ** ๐ โ ๐ข ๐ข ๐ ๏ธ โ๏ธ ๐ ๐ฝ ๐ท ๐, ๐ ๐ซ ๐ ๐ฅ โฎ๏ธ โ ๐ ๏ธ ๐งฌ ๐ ๐, & ๐ ๐ซ ๐ ๐
๐ 1๏ธโฃ ๐ฆ โฎ๏ธ ๐ ๐ฑ. โ๏ธ ๐ฅ ๐ ๐ ๏ธ โฎ๏ธ **โ โ**, ๐ ๐ ๐ ๐ฝ, โ๏ธ.
@@ -585,7 +585,7 @@ COPY ./app /app/app
๐ผ:
* โฎ๏ธ **โ โ** ๐ ๐ฝ
-* โฎ๏ธ **Kubernete** ๐
+* โฎ๏ธ **Kubernetes** ๐
* โฎ๏ธ โ ๐ ๐ณ ๐
* โฎ๏ธ โ1๏ธโฃ ๐งฐ ๐ ๐
* โฎ๏ธ โ ๐โ๐ฆบ ๐ โ ๐ ๐ฆ ๐ผ & ๐ ๏ธ โซ๏ธ
@@ -682,7 +682,7 @@ CMD ["uvicorn", "app.main:app", "--proxy-headers", "--host", "0.0.0.0", "--port"
## ๐
-โ๏ธ ๐ฆ โ๏ธ (โ
โฎ๏ธ **โ** & **Kubernete**) โซ๏ธ โถ๏ธ๏ธ ๐ถ ๐ฏ ๐ต ๐ **๐ ๏ธ ๐ง**:
+โ๏ธ ๐ฆ โ๏ธ (โ
โฎ๏ธ **โ** & **Kubernetes**) โซ๏ธ โถ๏ธ๏ธ ๐ถ ๐ฏ ๐ต ๐ **๐ ๏ธ ๐ง**:
* ๐บ๐ธ๐
* ๐โโ ๐ ๐ด
diff --git a/docs/em/docs/deployment/server-workers.md b/docs/em/docs/deployment/server-workers.md
index ca068d744..b7e58c4f4 100644
--- a/docs/em/docs/deployment/server-workers.md
+++ b/docs/em/docs/deployment/server-workers.md
@@ -18,9 +18,9 @@
๐ฅ ๐ค ๐ ๐ฆ ๐ โ โ๏ธ **๐** โฎ๏ธ **Uvicorn ๐จโ๐ญ ๐ ๏ธ**.
!!! info
- ๐ฅ ๐ โ๏ธ ๐ฆ, ๐ผ โฎ๏ธ โ โ๏ธ Kubernete, ๐ค ๐ ๐ฌ ๐ ๐
๐ ๐ โญ ๐: [FastAPI ๐ฆ - โ](./docker.md){.internal-link target=_blank}.
+ ๐ฅ ๐ โ๏ธ ๐ฆ, ๐ผ โฎ๏ธ โ โ๏ธ Kubernetes, ๐ค ๐ ๐ฌ ๐ ๐
๐ ๐ โญ ๐: [FastAPI ๐ฆ - โ](./docker.md){.internal-link target=_blank}.
- ๐ฏ, ๐โ ๐ ๐ **Kubernete** ๐ ๐ ๐ฒ **๐ซ** ๐ โ๏ธ ๐ & โฉ๏ธ ๐ **๐ Uvicorn ๐ ๏ธ ๐ ๐ฆ**, โ๏ธ ๐ค ๐ ๐ฌ ๐ ๐ โซ๏ธ โช ๐ ๐.
+ ๐ฏ, ๐โ ๐ ๐ **Kubernetes** ๐ ๐ ๐ฒ **๐ซ** ๐ โ๏ธ ๐ & โฉ๏ธ ๐ **๐ Uvicorn ๐ ๏ธ ๐ ๐ฆ**, โ๏ธ ๐ค ๐ ๐ฌ ๐ ๐ โซ๏ธ โช ๐ ๐.
## ๐ โฎ๏ธ Uvicorn ๐จโ๐ญ
@@ -167,7 +167,7 @@ $ uvicorn main:app --host 0.0.0.0 --port 8080 --workers 4
๐ค ๐ ๐ฆ ๐ **๐ โ ๐ผ** ๐ ๐ **๐ โฎ๏ธ Uvicorn ๐จโ๐ญ** & ๐ข ๐ณ ๐ ๐ช โ ๐
๐ผ.
-๐ค ๐ค ๐ ๐ฆ ๐ โ **๐ ๐ ๐ ๐ผ โช๏ธโก๏ธ ๐** ๐ ๐ Uvicorn ๐ ๏ธ (๐ต ๐). โซ๏ธ ๐
๐ ๏ธ & ๐ฒ โซ๏ธโ ๐ ๐ ๐ ๐โ โ๏ธ ๐ ๐ฆ ๐งพ โ๏ธ ๐ **Kubernete**.
+๐ค ๐ค ๐ ๐ฆ ๐ โ **๐ ๐ ๐ ๐ผ โช๏ธโก๏ธ ๐** ๐ ๐ Uvicorn ๐ ๏ธ (๐ต ๐). โซ๏ธ ๐
๐ ๏ธ & ๐ฒ โซ๏ธโ ๐ ๐ ๐ ๐โ โ๏ธ ๐ ๐ฆ ๐งพ โ๏ธ ๐ **Kubernetes**.
## ๐
@@ -175,4 +175,4 @@ $ uvicorn main:app --host 0.0.0.0 --port 8080 --workers 4
๐ ๐ช โ๏ธ ๐ ๐งฐ & ๐ญ ๐ฅ ๐ โ ๐ **๐ ๐ ๐ ๏ธ โ๏ธ** โช โ ๐
๐ ๐ ๏ธ ๐ง ๐.
-โ
๐
โญ ๐ ๐ก ๐ **FastAPI** โฎ๏ธ ๐ฆ (โ
โ & Kubernete). ๐ ๐ ๐ ๐ ๐ ๐งฐ โ๏ธ ๐
๐ โ ๐ **๐ ๏ธ ๐ง** ๐. ๐ถ
+โ
๐
โญ ๐ ๐ก ๐ **FastAPI** โฎ๏ธ ๐ฆ (โ
โ & Kubernetes). ๐ ๐ ๐ ๐ ๐ ๐งฐ โ๏ธ ๐
๐ โ ๐ **๐ ๏ธ ๐ง** ๐. ๐ถ
diff --git a/docs/em/docs/external-links.md b/docs/em/docs/external-links.md
index 4440b1f12..5ba668bfa 100644
--- a/docs/em/docs/external-links.md
+++ b/docs/em/docs/external-links.md
@@ -11,77 +11,21 @@
## ๐
-### ๐ช๐ธ
+{% for section_name, section_content in external_links.items() %}
-{% if external_links %}
-{% for article in external_links.articles.english %}
+## {{ section_name }}
+
+{% for lang_name, lang_content in section_content.items() %}
+
+### {{ lang_name }}
+
+{% for item in lang_content %}
+
+* {{ item.title }} by {{ item.author }}.
-* {{ article.title }} {{ article.author }}.
{% endfor %}
-{% endif %}
-
-### ๐ฏ๐ต
-
-{% if external_links %}
-{% for article in external_links.articles.japanese %}
-
-* {{ article.title }} {{ article.author }}.
{% endfor %}
-{% endif %}
-
-### ๐ป๐ณ
-
-{% if external_links %}
-{% for article in external_links.articles.vietnamese %}
-
-* {{ article.title }} {{ article.author }}.
{% endfor %}
-{% endif %}
-
-### ๐ท๐บ
-
-{% if external_links %}
-{% for article in external_links.articles.russian %}
-
-* {{ article.title }} {{ article.author }}.
-{% endfor %}
-{% endif %}
-
-### ๐ฉ๐ช
-
-{% if external_links %}
-{% for article in external_links.articles.german %}
-
-* {{ article.title }} {{ article.author }}.
-{% endfor %}
-{% endif %}
-
-### ๐น๐ผ
-
-{% if external_links %}
-{% for article in external_links.articles.taiwanese %}
-
-* {{ article.title }} {{ article.author }}.
-{% endfor %}
-{% endif %}
-
-## ๐ป
-
-{% if external_links %}
-{% for article in external_links.podcasts.english %}
-
-* {{ article.title }} {{ article.author }}.
-{% endfor %}
-{% endif %}
-
-## ๐ฌ
-
-{% if external_links %}
-{% for article in external_links.talks.english %}
-
-* {{ article.title }} {{ article.author }}.
-{% endfor %}
-{% endif %}
## ๐
diff --git a/docs/em/docs/help-fastapi.md b/docs/em/docs/help-fastapi.md
index d7b66185d..b998ade42 100644
--- a/docs/em/docs/help-fastapi.md
+++ b/docs/em/docs/help-fastapi.md
@@ -231,8 +231,6 @@
โ๏ธ ๐ฌ ๐ด ๐ ๐ข ๐ฌ.
-๐ค โฎ๏ธ ๐ฅ ๐ฌ, โ๏ธ โซ๏ธ ๐ซ โ๏ธ ๐ป & ๐ง โ, ๐ฌ ๐ โ , ๐ง ๐ ๐ โ๏ธ.
-
### ๐ซ โ๏ธ ๐ฌ โ
โ๏ธ ๐คฏ ๐ ๐ฌ โ ๐
"๐ ๐ฌ", โซ๏ธ โฉ ๐ญ โ ๐ ๐โโ๏ธ ๐ข & ๐
โ โ,, ๐ ๐ช ๐ซ ๐จ โ.
diff --git a/docs/em/docs/advanced/conditional-openapi.md b/docs/em/docs/how-to/conditional-openapi.md
similarity index 100%
rename from docs/em/docs/advanced/conditional-openapi.md
rename to docs/em/docs/how-to/conditional-openapi.md
diff --git a/docs/em/docs/advanced/custom-request-and-route.md b/docs/em/docs/how-to/custom-request-and-route.md
similarity index 100%
rename from docs/em/docs/advanced/custom-request-and-route.md
rename to docs/em/docs/how-to/custom-request-and-route.md
diff --git a/docs/em/docs/how-to/extending-openapi.md b/docs/em/docs/how-to/extending-openapi.md
new file mode 100644
index 000000000..6b3bc0075
--- /dev/null
+++ b/docs/em/docs/how-to/extending-openapi.md
@@ -0,0 +1,90 @@
+# โ ๐
+
+!!! warning
+ ๐ ๐ ๐ง โ. ๐ ๐ฒ ๐ช ๐ถ โซ๏ธ.
+
+ ๐ฅ ๐ ๐ ๐ฐ - ๐ฉโ๐ป ๐ฆฎ, ๐ ๐ช ๐ฒ ๐ถ ๐ ๐.
+
+ ๐ฅ ๐ โช ๐ญ ๐ ๐ ๐ช ๐ ๐ ๐ ๐, ๐ฃ ๐.
+
+๐ค ๐ผ ๐โ ๐ ๐ช ๐ช ๐ ๐ ๐ ๐.
+
+๐ ๐ ๐ ๐ ๐ โ.
+
+## ๐ ๐ ๏ธ
+
+๐ (๐ข) ๐ ๏ธ, โฉ.
+
+`FastAPI` ๐ธ (๐) โ๏ธ `.openapi()` ๐ฉโ๐ฌ ๐ ๐ ๐จ ๐ ๐.
+
+๐ ๐ธ ๐ ๐, *โก ๐ ๏ธ* `/openapi.json` (โ๏ธ โซ๏ธโ ๐ โ ๐ `openapi_url`) ยฎ.
+
+โซ๏ธ ๐จ ๐ป ๐จ โฎ๏ธ ๐ ๐ธ `.openapi()` ๐ฉโ๐ฌ.
+
+๐ข, โซ๏ธโ ๐ฉโ๐ฌ `.openapi()` ๐จ โ
๐ `.openapi_schema` ๐ ๐ฅ โซ๏ธ โ๏ธ ๐ & ๐จ ๐ซ.
+
+๐ฅ โซ๏ธ ๐ซ, โซ๏ธ ๐ ๐ซ โ๏ธ ๐ ๐ข `fastapi.openapi.utils.get_openapi`.
+
+& ๐ ๐ข `get_openapi()` ๐จ ๐ข:
+
+* `title`: ๐ ๐, ๐ฆ ๐ฉบ.
+* `version`: โฌ ๐ ๐ ๏ธ, โ
`2.5.0`.
+* `openapi_version`: โฌ ๐ ๐ง โ๏ธ. ๐ข, โช: `3.0.2`.
+* `description`: ๐ ๐ ๐ ๏ธ.
+* `routes`: ๐ ๐ฃ, ๐ซ ๐ ยฎ *โก ๐ ๏ธ*. ๐ซ โ โช๏ธโก๏ธ `app.routes`.
+
+## ๐ ๐ข
+
+โ๏ธ โน ๐, ๐ ๐ช โ๏ธ ๐ ๐ ๐ข ๐ ๐ ๐ & ๐ ๐ ๐ ๐ ๐ ๐ช.
+
+๐ผ, โก๏ธ ๐ฎ ๐ ๐ โ ๐ ๐ ๐ฑ.
+
+### ๐ **FastAPI**
+
+๐ฅ, โ ๐ ๐ **FastAPI** ๐ธ ๐:
+
+```Python hl_lines="1 4 7-9"
+{!../../../docs_src/extending_openapi/tutorial001.py!}
+```
+
+### ๐ ๐ ๐
+
+โคด๏ธ, โ๏ธ ๐ ๐ ๐ข ๐ ๐ ๐, ๐ `custom_openapi()` ๐ข:
+
+```Python hl_lines="2 15-20"
+{!../../../docs_src/extending_openapi/tutorial001.py!}
+```
+
+### ๐ ๐ ๐
+
+๐ ๐ ๐ช ๐ฎ ๐ โ, โ ๐ `x-logo` `info` "๐" ๐ ๐:
+
+```Python hl_lines="21-23"
+{!../../../docs_src/extending_openapi/tutorial001.py!}
+```
+
+### ๐พ ๐ ๐
+
+๐ ๐ช โ๏ธ ๐ `.openapi_schema` "๐พ", ๐ช ๐ ๐ ๐.
+
+๐ ๐, ๐ ๐ธ ๐ ๐ซ โ๏ธ ๐ ๐ ๐ ๐ฐ ๐ฉโ๐ป ๐ ๐ ๐ ๏ธ ๐ฉบ.
+
+โซ๏ธ ๐ ๐ ๐ด ๐, & โคด๏ธ ๐ ๐พ ๐ ๐ โ๏ธ โญ ๐จ.
+
+```Python hl_lines="13-14 24-25"
+{!../../../docs_src/extending_openapi/tutorial001.py!}
+```
+
+### ๐ ๐ฉโ๐ฌ
+
+๐ ๐ ๐ช โ `.openapi()` ๐ฉโ๐ฌ โฎ๏ธ ๐ ๐ ๐ข.
+
+```Python hl_lines="28"
+{!../../../docs_src/extending_openapi/tutorial001.py!}
+```
+
+### โ
โซ๏ธ
+
+๐ ๐ ๐ถ http://127.0.0.1:8000/redoc ๐ ๐ ๐ ๐ ๐ โ๏ธ ๐ ๐ ๐ฑ (๐ ๐ผ, **FastAPI**'โ ๐ฑ):
+
+
diff --git a/docs/em/docs/advanced/graphql.md b/docs/em/docs/how-to/graphql.md
similarity index 100%
rename from docs/em/docs/advanced/graphql.md
rename to docs/em/docs/how-to/graphql.md
diff --git a/docs/em/docs/advanced/sql-databases-peewee.md b/docs/em/docs/how-to/sql-databases-peewee.md
similarity index 100%
rename from docs/em/docs/advanced/sql-databases-peewee.md
rename to docs/em/docs/how-to/sql-databases-peewee.md
diff --git a/docs/em/docs/project-generation.md b/docs/em/docs/project-generation.md
index 5fd667ad1..ae959e1d5 100644
--- a/docs/em/docs/project-generation.md
+++ b/docs/em/docs/project-generation.md
@@ -79,6 +79,6 @@
* **๐** ๐ ๐ท ๐ ๏ธ.
* **โ ๐ง ๐** ๐จ ๐ ๐.
* **๐ญ ๐** ๐ ๐ธ ๐ฝ โ๏ธ Uvicorn & ๐.
-* **โ ๐ฉโ๐ป** Kubernete (๐ฆฒ) ๐/๐ฟ ๐ ๏ธ ๐.
+* **โ ๐ฉโ๐ป** Kubernetes (๐ฆฒ) ๐/๐ฟ ๐ ๏ธ ๐.
* **๐คธโโ** ๐ช โ 1๏ธโฃ ๐ ๐ ๐ช๐ธ โฎ๏ธ ๐ ๐ฅ.
* **๐ช ๐ง** ๐ ๐ท ๐ ๏ธ (Pytorch, ๐ธ๐ฒ), ๐ซ ๐.
diff --git a/docs/en/data/external_links.yml b/docs/en/data/external_links.yml
index a7f766d16..726e7eae7 100644
--- a/docs/en/data/external_links.yml
+++ b/docs/en/data/external_links.yml
@@ -1,5 +1,5 @@
-articles:
- english:
+Articles:
+ English:
- author: Adejumo Ridwan Suleiman
author_link: https://www.linkedin.com/in/adejumoridwan/
link: https://medium.com/python-in-plain-english/build-an-sms-spam-classifier-serverless-database-with-faunadb-and-fastapi-23dbb275bc5b
@@ -236,7 +236,7 @@ articles:
author_link: https://medium.com/@krishnardt365
link: https://medium.com/@krishnardt365/fastapi-docker-and-postgres-91943e71be92
title: Fastapi, Docker(Docker compose) and Postgres
- german:
+ German:
- author: Marcel Sander (actidoo)
author_link: https://www.actidoo.com
link: https://www.actidoo.com/de/blog/python-fastapi-domain-driven-design
@@ -249,7 +249,7 @@ articles:
author_link: https://hellocoding.de/autor/felix-schuermeyer/
link: https://hellocoding.de/blog/coding-language/python/fastapi
title: REST-API Programmieren mittels Python und dem FastAPI Modul
- japanese:
+ Japanese:
- author: '@bee2'
author_link: https://qiita.com/bee2
link: https://qiita.com/bee2/items/75d9c0d7ba20e7a4a0e9
@@ -298,7 +298,7 @@ articles:
author_link: https://qiita.com/mtitg
link: https://qiita.com/mtitg/items/47770e9a562dd150631d
title: FastAPI๏ฝDBๆฅ็ถใใฆCRUDใใPython่ฃฝAPIใตใผใใผใๆง็ฏ
- russian:
+ Russian:
- author: Troy Kรถhler
author_link: https://www.linkedin.com/in/trkohler/
link: https://trkohler.com/fast-api-introduction-to-framework
@@ -311,18 +311,18 @@ articles:
author_link: https://habr.com/ru/users/57uff3r/
link: https://habr.com/ru/post/454440/
title: 'ะะตะปะบะฐั ะฟะธัะพะฝััะฐั ัะฐะดะพััั #2: Starlette - ะกะพะปะธะดะฝะฐั ะฟัะธะผะพัะบะฐ โ FastAPI'
- vietnamese:
+ Vietnamese:
- author: Nguyแป
n Nhรขn
author_link: https://fullstackstation.com/author/figonking/
link: https://fullstackstation.com/fastapi-trien-khai-bang-docker/
title: 'FASTAPI: TRIแปN KHAI BแบฐNG DOCKER'
- taiwanese:
+ Taiwanese:
- author: Leon
author_link: http://editor.leonh.space/
link: https://editor.leonh.space/2022/tortoise/
title: 'Tortoise ORM / FastAPI ๆดๅๅฟซ้็ญ่จ'
-podcasts:
- english:
+Podcasts:
+ English:
- author: Podcast.`__init__`
author_link: https://www.pythonpodcast.com/
link: https://www.pythonpodcast.com/fastapi-web-application-framework-episode-259/
@@ -331,8 +331,8 @@ podcasts:
author_link: https://pythonbytes.fm/
link: https://pythonbytes.fm/episodes/show/123/time-to-right-the-py-wrongs?time_in_sec=855
title: FastAPI on PythonBytes
-talks:
- english:
+Talks:
+ English:
- author: Sebastiรกn Ramรญrez (tiangolo)
author_link: https://twitter.com/tiangolo
link: https://www.youtube.com/watch?v=PnpTY1f4k2U
diff --git a/docs/en/data/github_sponsors.yml b/docs/en/data/github_sponsors.yml
index 3a68ba62b..b9d74ea7b 100644
--- a/docs/en/data/github_sponsors.yml
+++ b/docs/en/data/github_sponsors.yml
@@ -1,7 +1,13 @@
sponsors:
-- - login: cryptapi
+- - login: bump-sh
+ avatarUrl: https://avatars.githubusercontent.com/u/33217836?v=4
+ url: https://github.com/bump-sh
+ - login: cryptapi
avatarUrl: https://avatars.githubusercontent.com/u/44925437?u=61369138589bc7fee6c417f3fbd50fbd38286cc4&v=4
url: https://github.com/cryptapi
+ - login: porter-dev
+ avatarUrl: https://avatars.githubusercontent.com/u/62078005?v=4
+ url: https://github.com/porter-dev
- login: fern-api
avatarUrl: https://avatars.githubusercontent.com/u/102944815?v=4
url: https://github.com/fern-api
@@ -17,6 +23,9 @@ sponsors:
- - login: mikeckennedy
avatarUrl: https://avatars.githubusercontent.com/u/2035561?u=1bb18268bcd4d9249e1f783a063c27df9a84c05b&v=4
url: https://github.com/mikeckennedy
+ - login: ndimares
+ avatarUrl: https://avatars.githubusercontent.com/u/6267663?u=cfb27efde7a7212be8142abb6c058a1aeadb41b1&v=4
+ url: https://github.com/ndimares
- login: deta
avatarUrl: https://avatars.githubusercontent.com/u/47275976?v=4
url: https://github.com/deta
@@ -32,12 +41,6 @@ sponsors:
- login: VincentParedes
avatarUrl: https://avatars.githubusercontent.com/u/103889729?v=4
url: https://github.com/VincentParedes
-- - login: arcticfly
- avatarUrl: https://avatars.githubusercontent.com/u/41524992?u=03c88529a86cf51f7a380e890d84d84c71468848&v=4
- url: https://github.com/arcticfly
-- - login: getsentry
- avatarUrl: https://avatars.githubusercontent.com/u/1396951?v=4
- url: https://github.com/getsentry
- - login: acsone
avatarUrl: https://avatars.githubusercontent.com/u/7601056?v=4
url: https://github.com/acsone
@@ -50,9 +53,6 @@ sponsors:
- login: marvin-robot
avatarUrl: https://avatars.githubusercontent.com/u/41086007?u=091c5cb75af363123d66f58194805a97220ee1a7&v=4
url: https://github.com/marvin-robot
- - login: Flint-company
- avatarUrl: https://avatars.githubusercontent.com/u/48908872?u=355cd3d8992d4be8173058e7000728757c55ad49&v=4
- url: https://github.com/Flint-company
- login: BoostryJP
avatarUrl: https://avatars.githubusercontent.com/u/57932412?v=4
url: https://github.com/BoostryJP
@@ -77,9 +77,6 @@ sponsors:
- login: AccentDesign
avatarUrl: https://avatars.githubusercontent.com/u/2429332?v=4
url: https://github.com/AccentDesign
- - login: RodneyU215
- avatarUrl: https://avatars.githubusercontent.com/u/3329665?u=ec6a9adf8e7e8e306eed7d49687c398608d1604f&v=4
- url: https://github.com/RodneyU215
- login: americanair
avatarUrl: https://avatars.githubusercontent.com/u/12281813?v=4
url: https://github.com/americanair
@@ -92,15 +89,9 @@ sponsors:
- login: primer-io
avatarUrl: https://avatars.githubusercontent.com/u/62146168?v=4
url: https://github.com/primer-io
-- - login: indeedeng
- avatarUrl: https://avatars.githubusercontent.com/u/2905043?v=4
- url: https://github.com/indeedeng
- - login: iguit0
- avatarUrl: https://avatars.githubusercontent.com/u/12905770?u=63a1a96d1e6c27d85c4f946b84836599de047f65&v=4
- url: https://github.com/iguit0
- - login: JacobKochems
- avatarUrl: https://avatars.githubusercontent.com/u/41692189?u=a75f62ddc0d060ee6233a91e19c433d2687b8eb6&v=4
- url: https://github.com/JacobKochems
+- - login: NateXVI
+ avatarUrl: https://avatars.githubusercontent.com/u/48195620?u=4bc8751ae50cb087c40c1fe811764aa070b9eea6&v=4
+ url: https://github.com/NateXVI
- - login: Kludex
avatarUrl: https://avatars.githubusercontent.com/u/7353520?u=62adc405ef418f4b6c8caa93d3eb8ab107bc4927&v=4
url: https://github.com/Kludex
@@ -113,9 +104,6 @@ sponsors:
- login: jstanden
avatarUrl: https://avatars.githubusercontent.com/u/63288?u=c3658d57d2862c607a0e19c2101c3c51876e36ad&v=4
url: https://github.com/jstanden
- - login: dekoza
- avatarUrl: https://avatars.githubusercontent.com/u/210980?u=c03c78a8ae1039b500dfe343665536ebc51979b2&v=4
- url: https://github.com/dekoza
- login: pamelafox
avatarUrl: https://avatars.githubusercontent.com/u/297042?v=4
url: https://github.com/pamelafox
@@ -143,9 +131,6 @@ sponsors:
- login: mickaelandrieu
avatarUrl: https://avatars.githubusercontent.com/u/1247388?u=599f6e73e452a9453f2bd91e5c3100750e731ad4&v=4
url: https://github.com/mickaelandrieu
- - login: jonakoudijs
- avatarUrl: https://avatars.githubusercontent.com/u/1906344?u=5ca0c9a1a89b6a2ba31abe35c66bdc07af60a632&v=4
- url: https://github.com/jonakoudijs
- login: Shark009
avatarUrl: https://avatars.githubusercontent.com/u/3163309?u=0c6f4091b0eda05c44c390466199826e6dc6e431&v=4
url: https://github.com/Shark009
@@ -200,12 +185,12 @@ sponsors:
- login: hiancdtrsnm
avatarUrl: https://avatars.githubusercontent.com/u/7343177?v=4
url: https://github.com/hiancdtrsnm
- - login: Shackelford-Arden
- avatarUrl: https://avatars.githubusercontent.com/u/7362263?v=4
- url: https://github.com/Shackelford-Arden
- login: wdwinslow
avatarUrl: https://avatars.githubusercontent.com/u/11562137?u=dc01daafb354135603a263729e3d26d939c0c452&v=4
url: https://github.com/wdwinslow
+ - login: jsoques
+ avatarUrl: https://avatars.githubusercontent.com/u/12414216?u=620921d94196546cc8b9eae2cc4cbc3f95bab42f&v=4
+ url: https://github.com/jsoques
- login: joeds13
avatarUrl: https://avatars.githubusercontent.com/u/13631604?u=628eb122e08bef43767b3738752b883e8e7f6259&v=4
url: https://github.com/joeds13
@@ -227,9 +212,9 @@ sponsors:
- login: Filimoa
avatarUrl: https://avatars.githubusercontent.com/u/21352040?u=0be845711495bbd7b756e13fcaeb8efc1ebd78ba&v=4
url: https://github.com/Filimoa
- - login: LarryGF
- avatarUrl: https://avatars.githubusercontent.com/u/26148349?u=431bb34d36d41c172466252242175281ae132152&v=4
- url: https://github.com/LarryGF
+ - login: rahulsalgare
+ avatarUrl: https://avatars.githubusercontent.com/u/21974430?u=ade6f182b94554ab8491d7421de5e78f711dcaf8&v=4
+ url: https://github.com/rahulsalgare
- login: BrettskiPy
avatarUrl: https://avatars.githubusercontent.com/u/30988215?u=d8a94a67e140d5ee5427724b292cc52d8827087a&v=4
url: https://github.com/BrettskiPy
@@ -239,15 +224,15 @@ sponsors:
- login: Leay15
avatarUrl: https://avatars.githubusercontent.com/u/32212558?u=c4aa9c1737e515959382a5515381757b1fd86c53&v=4
url: https://github.com/Leay15
+ - login: dvlpjrs
+ avatarUrl: https://avatars.githubusercontent.com/u/32254642?u=fbd6ad0324d4f1eb6231cf775be1c7bd4404e961&v=4
+ url: https://github.com/dvlpjrs
- login: ygorpontelo
avatarUrl: https://avatars.githubusercontent.com/u/32963605?u=35f7103f9c4c4c2589ae5737ee882e9375ef072e&v=4
url: https://github.com/ygorpontelo
- login: ProteinQure
avatarUrl: https://avatars.githubusercontent.com/u/33707203?v=4
url: https://github.com/ProteinQure
- - login: askurihin
- avatarUrl: https://avatars.githubusercontent.com/u/37978981?v=4
- url: https://github.com/askurihin
- login: arleybri18
avatarUrl: https://avatars.githubusercontent.com/u/39681546?u=5c028f81324b0e8c73b3c15bc4e7b0218d2ba0c3&v=4
url: https://github.com/arleybri18
@@ -266,18 +251,12 @@ sponsors:
- login: dudikbender
avatarUrl: https://avatars.githubusercontent.com/u/53487583?u=3a57542938ebfd57579a0111db2b297e606d9681&v=4
url: https://github.com/dudikbender
- - login: thisistheplace
- avatarUrl: https://avatars.githubusercontent.com/u/57633545?u=a3f3a7f8ace8511c6c067753f6eb6aee0db11ac6&v=4
- url: https://github.com/thisistheplace
- login: yakkonaut
avatarUrl: https://avatars.githubusercontent.com/u/60633704?u=90a71fd631aa998ba4a96480788f017c9904e07b&v=4
url: https://github.com/yakkonaut
- login: patsatsia
avatarUrl: https://avatars.githubusercontent.com/u/61111267?u=3271b85f7a37b479c8d0ae0a235182e83c166edf&v=4
url: https://github.com/patsatsia
- - login: daverin
- avatarUrl: https://avatars.githubusercontent.com/u/70378377?u=6d1814195c0de7162820eaad95a25b423a3869c0&v=4
- url: https://github.com/daverin
- login: anthonycepeda
avatarUrl: https://avatars.githubusercontent.com/u/72019805?u=4252c6b6dc5024af502a823a3ac5e7a03a69963f&v=4
url: https://github.com/anthonycepeda
@@ -290,9 +269,6 @@ sponsors:
- login: pyt3h
avatarUrl: https://avatars.githubusercontent.com/u/99658549?v=4
url: https://github.com/pyt3h
- - login: Dagmaara
- avatarUrl: https://avatars.githubusercontent.com/u/115501964?v=4
- url: https://github.com/Dagmaara
- - login: SebTota
avatarUrl: https://avatars.githubusercontent.com/u/25122511?v=4
url: https://github.com/SebTota
@@ -305,6 +281,9 @@ sponsors:
- login: bryanculbertson
avatarUrl: https://avatars.githubusercontent.com/u/144028?u=defda4f90e93429221cc667500944abde60ebe4a&v=4
url: https://github.com/bryanculbertson
+ - login: yourkin
+ avatarUrl: https://avatars.githubusercontent.com/u/178984?u=b43a7e5f8818f7d9083d3b110118d9c27d48a794&v=4
+ url: https://github.com/yourkin
- login: slafs
avatarUrl: https://avatars.githubusercontent.com/u/210173?v=4
url: https://github.com/slafs
@@ -320,15 +299,15 @@ sponsors:
- login: securancy
avatarUrl: https://avatars.githubusercontent.com/u/606673?v=4
url: https://github.com/securancy
- - login: hardbyte
- avatarUrl: https://avatars.githubusercontent.com/u/855189?u=aa29e92f34708814d6b67fcd47ca4cf2ce1c04ed&v=4
- url: https://github.com/hardbyte
- login: browniebroke
avatarUrl: https://avatars.githubusercontent.com/u/861044?u=5abfca5588f3e906b31583d7ee62f6de4b68aa24&v=4
url: https://github.com/browniebroke
- login: janfilips
avatarUrl: https://avatars.githubusercontent.com/u/870699?u=80702ec63f14e675cd4cdcc6ce3821d2ed207fd7&v=4
url: https://github.com/janfilips
+ - login: dodo5522
+ avatarUrl: https://avatars.githubusercontent.com/u/1362607?u=9bf1e0e520cccc547c046610c468ce6115bbcf9f&v=4
+ url: https://github.com/dodo5522
- login: WillHogan
avatarUrl: https://avatars.githubusercontent.com/u/1661551?u=7036c064cf29781470573865264ec8e60b6b809f&v=4
url: https://github.com/WillHogan
@@ -374,9 +353,6 @@ sponsors:
- login: katnoria
avatarUrl: https://avatars.githubusercontent.com/u/7674948?u=09767eb13e07e09496c5fee4e5ce21d9eac34a56&v=4
url: https://github.com/katnoria
- - login: mattwelke
- avatarUrl: https://avatars.githubusercontent.com/u/7719209?u=80f02a799323b1472b389b836d95957c93a6d856&v=4
- url: https://github.com/mattwelke
- login: harsh183
avatarUrl: https://avatars.githubusercontent.com/u/7780198?v=4
url: https://github.com/harsh183
@@ -422,6 +398,9 @@ sponsors:
- login: jangia
avatarUrl: https://avatars.githubusercontent.com/u/17927101?u=9261b9bb0c3e3bb1ecba43e8915dc58d8c9a077e&v=4
url: https://github.com/jangia
+ - login: timzaz
+ avatarUrl: https://avatars.githubusercontent.com/u/19709244?u=264d7db95c28156363760229c30ee1116efd4eeb&v=4
+ url: https://github.com/timzaz
- login: shuheng-liu
avatarUrl: https://avatars.githubusercontent.com/u/22414322?u=813c45f30786c6b511b21a661def025d8f7b609e&v=4
url: https://github.com/shuheng-liu
@@ -431,12 +410,18 @@ sponsors:
- login: kxzk
avatarUrl: https://avatars.githubusercontent.com/u/25046261?u=e185e58080090f9e678192cd214a14b14a2b232b&v=4
url: https://github.com/kxzk
+ - login: nisutec
+ avatarUrl: https://avatars.githubusercontent.com/u/25281462?u=e562484c451fdfc59053163f64405f8eb262b8b0&v=4
+ url: https://github.com/nisutec
- login: hoenie-ams
avatarUrl: https://avatars.githubusercontent.com/u/25708487?u=cda07434f0509ac728d9edf5e681117c0f6b818b&v=4
url: https://github.com/hoenie-ams
- login: joerambo
avatarUrl: https://avatars.githubusercontent.com/u/26282974?v=4
url: https://github.com/joerambo
+ - login: msniezynski
+ avatarUrl: https://avatars.githubusercontent.com/u/27588547?u=0e3be5ac57dcfdf124f470bcdf74b5bf79af1b6c&v=4
+ url: https://github.com/msniezynski
- login: rlnchow
avatarUrl: https://avatars.githubusercontent.com/u/28018479?u=a93ca9cf1422b9ece155784a72d5f2fdbce7adff&v=4
url: https://github.com/rlnchow
@@ -450,7 +435,7 @@ sponsors:
avatarUrl: https://avatars.githubusercontent.com/u/33275230?u=eb223cad27017bb1e936ee9b429b450d092d0236&v=4
url: https://github.com/engineerjoe440
- login: bnkc
- avatarUrl: https://avatars.githubusercontent.com/u/34930566?u=527044d90b5ebb7f8dad517db5da1f45253b774b&v=4
+ avatarUrl: https://avatars.githubusercontent.com/u/34930566?u=1a104991a2ea90bfe304bc0b9ef191c7e4891a0e&v=4
url: https://github.com/bnkc
- login: declon
avatarUrl: https://avatars.githubusercontent.com/u/36180226?v=4
@@ -458,6 +443,12 @@ sponsors:
- login: miraedbswo
avatarUrl: https://avatars.githubusercontent.com/u/36796047?u=9e7a5b3e558edc61d35d0f9dfac37541bae7f56d&v=4
url: https://github.com/miraedbswo
+ - login: DSMilestone6538
+ avatarUrl: https://avatars.githubusercontent.com/u/37230924?u=f299dce910366471523155e0cb213356d34aadc1&v=4
+ url: https://github.com/DSMilestone6538
+ - login: curegit
+ avatarUrl: https://avatars.githubusercontent.com/u/37978051?u=1733c322079118c0cdc573c03d92813f50a9faec&v=4
+ url: https://github.com/curegit
- login: kristiangronberg
avatarUrl: https://avatars.githubusercontent.com/u/42678548?v=4
url: https://github.com/kristiangronberg
@@ -482,6 +473,12 @@ sponsors:
- login: 0417taehyun
avatarUrl: https://avatars.githubusercontent.com/u/63915557?u=47debaa860fd52c9b98c97ef357ddcec3b3fb399&v=4
url: https://github.com/0417taehyun
+ - login: romabozhanovgithub
+ avatarUrl: https://avatars.githubusercontent.com/u/67696229?u=e4b921eef096415300425aca249348f8abb78ad7&v=4
+ url: https://github.com/romabozhanovgithub
+ - login: mbukeRepo
+ avatarUrl: https://avatars.githubusercontent.com/u/70356088?u=d2eb23e2b222a3b316c4183b05a3236b32819dc2&v=4
+ url: https://github.com/mbukeRepo
- - login: ssbarnea
avatarUrl: https://avatars.githubusercontent.com/u/102495?u=b4bf6818deefe59952ac22fec6ed8c76de1b8f7c&v=4
url: https://github.com/ssbarnea
@@ -494,21 +491,18 @@ sponsors:
- login: sadikkuzu
avatarUrl: https://avatars.githubusercontent.com/u/23168063?u=d179c06bb9f65c4167fcab118526819f8e0dac17&v=4
url: https://github.com/sadikkuzu
- - login: ruizdiazever
- avatarUrl: https://avatars.githubusercontent.com/u/29817086?u=2df54af55663d246e3a4dc8273711c37f1adb117&v=4
- url: https://github.com/ruizdiazever
- login: samnimoh
avatarUrl: https://avatars.githubusercontent.com/u/33413170?u=147bc516be6cb647b28d7e3b3fea3a018a331145&v=4
url: https://github.com/samnimoh
- login: danburonline
avatarUrl: https://avatars.githubusercontent.com/u/34251194?u=2cad4388c1544e539ecb732d656e42fb07b4ff2d&v=4
url: https://github.com/danburonline
- - login: iharshgor
- avatarUrl: https://avatars.githubusercontent.com/u/35490011?u=2dea054476e752d9e92c9d71a9a7cc919b1c2f8e&v=4
- url: https://github.com/iharshgor
- login: rwxd
avatarUrl: https://avatars.githubusercontent.com/u/40308458?u=cd04a39e3655923be4f25c2ba8a5a07b3da3230a&v=4
url: https://github.com/rwxd
- - login: ThomasPalma1
- avatarUrl: https://avatars.githubusercontent.com/u/66331874?u=5763f7402d784ba189b60d704ff5849b4d0a63fb&v=4
- url: https://github.com/ThomasPalma1
+ - login: shywn-mrk
+ avatarUrl: https://avatars.githubusercontent.com/u/51455763?u=389e2608e4056fe5e1f23e9ad56a9415277504d3&v=4
+ url: https://github.com/shywn-mrk
+ - login: almeida-matheus
+ avatarUrl: https://avatars.githubusercontent.com/u/66216198?u=54335eaa0ced626be5c1ff52fead1ebc032286ec&v=4
+ url: https://github.com/almeida-matheus
diff --git a/docs/en/data/people.yml b/docs/en/data/people.yml
index 89d189564..db06cbdaf 100644
--- a/docs/en/data/people.yml
+++ b/docs/en/data/people.yml
@@ -1,16 +1,16 @@
maintainers:
- login: tiangolo
- answers: 1849
- prs: 466
+ answers: 1868
+ prs: 496
avatarUrl: https://avatars.githubusercontent.com/u/1326112?u=740f11212a731f56798f558ceddb0bd07642afa7&v=4
url: https://github.com/tiangolo
experts:
- login: Kludex
- count: 463
+ count: 501
avatarUrl: https://avatars.githubusercontent.com/u/7353520?u=62adc405ef418f4b6c8caa93d3eb8ab107bc4927&v=4
url: https://github.com/Kludex
- login: dmontagu
- count: 239
+ count: 240
avatarUrl: https://avatars.githubusercontent.com/u/35119617?u=540f30c937a6450812628b9592a1dfe91bbe148e&v=4
url: https://github.com/dmontagu
- login: Mause
@@ -26,7 +26,7 @@ experts:
avatarUrl: https://avatars.githubusercontent.com/u/13659033?u=e8bea32d07a5ef72f7dde3b2079ceb714923ca05&v=4
url: https://github.com/JarroVGIT
- login: jgould22
- count: 157
+ count: 168
avatarUrl: https://avatars.githubusercontent.com/u/4335847?u=ed77f67e0bb069084639b24d812dbb2a2b1dc554&v=4
url: https://github.com/jgould22
- login: euri10
@@ -38,7 +38,7 @@ experts:
avatarUrl: https://avatars.githubusercontent.com/u/331403?v=4
url: https://github.com/phy25
- login: iudeen
- count: 121
+ count: 122
avatarUrl: https://avatars.githubusercontent.com/u/10519440?u=2843b3303282bff8b212dcd4d9d6689452e4470c&v=4
url: https://github.com/iudeen
- login: raphaelauv
@@ -61,38 +61,42 @@ experts:
count: 49
avatarUrl: https://avatars.githubusercontent.com/u/516999?u=437c0c5038558c67e887ccd863c1ba0f846c03da&v=4
url: https://github.com/sm-Fifteen
-- login: insomnes
- count: 45
- avatarUrl: https://avatars.githubusercontent.com/u/16958893?u=f8be7088d5076d963984a21f95f44e559192d912&v=4
- url: https://github.com/insomnes
-- login: yinziyan1206
- count: 45
- avatarUrl: https://avatars.githubusercontent.com/u/37829370?u=da44ca53aefd5c23f346fab8e9fd2e108294c179&v=4
- url: https://github.com/yinziyan1206
- login: acidjunk
count: 45
avatarUrl: https://avatars.githubusercontent.com/u/685002?u=b5094ab4527fc84b006c0ac9ff54367bdebb2267&v=4
url: https://github.com/acidjunk
+- login: insomnes
+ count: 45
+ avatarUrl: https://avatars.githubusercontent.com/u/16958893?u=f8be7088d5076d963984a21f95f44e559192d912&v=4
+ url: https://github.com/insomnes
- login: Dustyposa
count: 45
avatarUrl: https://avatars.githubusercontent.com/u/27180793?u=5cf2877f50b3eb2bc55086089a78a36f07042889&v=4
url: https://github.com/Dustyposa
- login: adriangb
- count: 44
+ count: 45
avatarUrl: https://avatars.githubusercontent.com/u/1755071?u=612704256e38d6ac9cbed24f10e4b6ac2da74ecb&v=4
url: https://github.com/adriangb
-- login: frankie567
- count: 43
- avatarUrl: https://avatars.githubusercontent.com/u/1144727?u=85c025e3fcc7bd79a5665c63ee87cdf8aae13374&v=4
- url: https://github.com/frankie567
+- login: yinziyan1206
+ count: 44
+ avatarUrl: https://avatars.githubusercontent.com/u/37829370?u=da44ca53aefd5c23f346fab8e9fd2e108294c179&v=4
+ url: https://github.com/yinziyan1206
- login: odiseo0
count: 43
avatarUrl: https://avatars.githubusercontent.com/u/87550035?u=241a71f6b7068738b81af3e57f45ffd723538401&v=4
url: https://github.com/odiseo0
+- login: frankie567
+ count: 43
+ avatarUrl: https://avatars.githubusercontent.com/u/1144727?u=c159fe047727aedecbbeeaa96a1b03ceb9d39add&v=4
+ url: https://github.com/frankie567
- login: includeamin
count: 40
avatarUrl: https://avatars.githubusercontent.com/u/11836741?u=8bd5ef7e62fe6a82055e33c4c0e0a7879ff8cfb6&v=4
url: https://github.com/includeamin
+- login: chbndrhnns
+ count: 38
+ avatarUrl: https://avatars.githubusercontent.com/u/7534547?v=4
+ url: https://github.com/chbndrhnns
- login: STeveShary
count: 37
avatarUrl: https://avatars.githubusercontent.com/u/5167622?u=de8f597c81d6336fcebc37b32dfd61a3f877160c&v=4
@@ -101,10 +105,10 @@ experts:
count: 35
avatarUrl: https://avatars.githubusercontent.com/u/31960541?u=47f4829c77f4962ab437ffb7995951e41eeebe9b&v=4
url: https://github.com/krishnardt
-- login: chbndrhnns
- count: 35
- avatarUrl: https://avatars.githubusercontent.com/u/7534547?v=4
- url: https://github.com/chbndrhnns
+- login: n8sty
+ count: 32
+ avatarUrl: https://avatars.githubusercontent.com/u/2964996?v=4
+ url: https://github.com/n8sty
- login: panla
count: 32
avatarUrl: https://avatars.githubusercontent.com/u/41326348?u=ba2fda6b30110411ecbf406d187907e2b420ac19&v=4
@@ -121,22 +125,22 @@ experts:
count: 25
avatarUrl: https://avatars.githubusercontent.com/u/365303?u=07ca03c5ee811eb0920e633cc3c3db73dbec1aa5&v=4
url: https://github.com/wshayes
-- login: acnebs
- count: 23
- avatarUrl: https://avatars.githubusercontent.com/u/9054108?v=4
- url: https://github.com/acnebs
- login: SirTelemak
count: 23
avatarUrl: https://avatars.githubusercontent.com/u/9435877?u=719327b7d2c4c62212456d771bfa7c6b8dbb9eac&v=4
url: https://github.com/SirTelemak
+- login: acnebs
+ count: 23
+ avatarUrl: https://avatars.githubusercontent.com/u/9054108?v=4
+ url: https://github.com/acnebs
- login: rafsaf
count: 21
- avatarUrl: https://avatars.githubusercontent.com/u/51059348?u=f8f0d6d6e90fac39fa786228158ba7f013c74271&v=4
+ avatarUrl: https://avatars.githubusercontent.com/u/51059348?u=5fe59a56e1f2f9ccd8005d71752a8276f133ae1a&v=4
url: https://github.com/rafsaf
-- login: n8sty
+- login: JavierSanchezCastro
count: 20
- avatarUrl: https://avatars.githubusercontent.com/u/2964996?v=4
- url: https://github.com/n8sty
+ avatarUrl: https://avatars.githubusercontent.com/u/72013291?u=ae5679e6bd971d9d98cd5e76e8683f83642ba950&v=4
+ url: https://github.com/JavierSanchezCastro
- login: nsidnev
count: 20
avatarUrl: https://avatars.githubusercontent.com/u/22559461?u=a9cc3238217e21dc8796a1a500f01b722adb082c&v=4
@@ -145,6 +149,10 @@ experts:
count: 20
avatarUrl: https://avatars.githubusercontent.com/u/565544?v=4
url: https://github.com/chris-allnutt
+- login: chrisK824
+ count: 19
+ avatarUrl: https://avatars.githubusercontent.com/u/79946379?u=03d85b22d696a58a9603e55fbbbe2de6b0f4face&v=4
+ url: https://github.com/chrisK824
- login: zoliknemet
count: 18
avatarUrl: https://avatars.githubusercontent.com/u/22326718?u=31ba446ac290e23e56eea8e4f0c558aaf0b40779&v=4
@@ -153,6 +161,10 @@ experts:
count: 18
avatarUrl: https://avatars.githubusercontent.com/u/24581770?v=4
url: https://github.com/retnikt
+- login: ebottos94
+ count: 17
+ avatarUrl: https://avatars.githubusercontent.com/u/100039558?u=e2c672da5a7977fd24d87ce6ab35f8bf5b1ed9fa&v=4
+ url: https://github.com/ebottos94
- login: Hultner
count: 17
avatarUrl: https://avatars.githubusercontent.com/u/2669034?u=115e53df959309898ad8dc9443fbb35fee71df07&v=4
@@ -169,6 +181,10 @@ experts:
count: 17
avatarUrl: https://avatars.githubusercontent.com/u/16540232?u=05d2beb8e034d584d0a374b99d8826327bd7f614&v=4
url: https://github.com/caeser1996
+- login: nymous
+ count: 16
+ avatarUrl: https://avatars.githubusercontent.com/u/4216559?u=360a36fb602cded27273cbfc0afc296eece90662&v=4
+ url: https://github.com/nymous
- login: jonatasoli
count: 16
avatarUrl: https://avatars.githubusercontent.com/u/26334101?u=071c062d2861d3dd127f6b4a5258cd8ef55d4c50&v=4
@@ -181,47 +197,23 @@ experts:
count: 15
avatarUrl: https://avatars.githubusercontent.com/u/25699289?u=b5d219277b4d001ac26fb8be357fddd88c29d51b&v=4
url: https://github.com/abhint
-- login: nymous
- count: 15
- avatarUrl: https://avatars.githubusercontent.com/u/4216559?u=360a36fb602cded27273cbfc0afc296eece90662&v=4
- url: https://github.com/nymous
-- login: ghost
- count: 15
- avatarUrl: https://avatars.githubusercontent.com/u/10137?u=b1951d34a583cf12ec0d3b0781ba19be97726318&v=4
- url: https://github.com/ghost
-- login: simondale00
- count: 15
- avatarUrl: https://avatars.githubusercontent.com/u/33907262?v=4
- url: https://github.com/simondale00
-- login: jorgerpo
- count: 15
- avatarUrl: https://avatars.githubusercontent.com/u/12537771?u=7444d20019198e34911082780cc7ad73f2b97cb3&v=4
- url: https://github.com/jorgerpo
last_month_active:
- login: Kludex
- count: 24
+ count: 8
avatarUrl: https://avatars.githubusercontent.com/u/7353520?u=62adc405ef418f4b6c8caa93d3eb8ab107bc4927&v=4
url: https://github.com/Kludex
-- login: jgould22
- count: 17
- avatarUrl: https://avatars.githubusercontent.com/u/4335847?u=ed77f67e0bb069084639b24d812dbb2a2b1dc554&v=4
- url: https://github.com/jgould22
-- login: arjwilliams
- count: 8
- avatarUrl: https://avatars.githubusercontent.com/u/22227620?v=4
- url: https://github.com/arjwilliams
-- login: Ahmed-Abdou14
+- login: n8sty
+ count: 7
+ avatarUrl: https://avatars.githubusercontent.com/u/2964996?v=4
+ url: https://github.com/n8sty
+- login: chrisK824
count: 4
- avatarUrl: https://avatars.githubusercontent.com/u/104530599?u=05365b155a1ff911532e8be316acfad2e0736f98&v=4
- url: https://github.com/Ahmed-Abdou14
-- login: iudeen
+ avatarUrl: https://avatars.githubusercontent.com/u/79946379?u=03d85b22d696a58a9603e55fbbbe2de6b0f4face&v=4
+ url: https://github.com/chrisK824
+- login: danielfcollier
count: 3
- avatarUrl: https://avatars.githubusercontent.com/u/10519440?u=2843b3303282bff8b212dcd4d9d6689452e4470c&v=4
- url: https://github.com/iudeen
-- login: mikeedjones
- count: 3
- avatarUrl: https://avatars.githubusercontent.com/u/4087139?u=cc4a242896ac2fcf88a53acfaf190d0fe0a1f0c9&v=4
- url: https://github.com/mikeedjones
+ avatarUrl: https://avatars.githubusercontent.com/u/38995330?u=5799be795fc310f75f3a5fe9242307d59b194520&v=4
+ url: https://github.com/danielfcollier
top_contributors:
- login: waynerv
count: 25
@@ -236,21 +228,21 @@ top_contributors:
avatarUrl: https://avatars.githubusercontent.com/u/7353520?u=62adc405ef418f4b6c8caa93d3eb8ab107bc4927&v=4
url: https://github.com/Kludex
- login: jaystone776
- count: 17
+ count: 18
avatarUrl: https://avatars.githubusercontent.com/u/11191137?u=299205a95e9b6817a43144a48b643346a5aac5cc&v=4
url: https://github.com/jaystone776
- login: dmontagu
- count: 16
+ count: 17
avatarUrl: https://avatars.githubusercontent.com/u/35119617?u=540f30c937a6450812628b9592a1dfe91bbe148e&v=4
url: https://github.com/dmontagu
+- login: Xewus
+ count: 14
+ avatarUrl: https://avatars.githubusercontent.com/u/85196001?u=f8e2dc7e5104f109cef944af79050ea8d1b8f914&v=4
+ url: https://github.com/Xewus
- login: euri10
count: 13
avatarUrl: https://avatars.githubusercontent.com/u/1104190?u=321a2e953e6645a7d09b732786c7a8061e0f8a8b&v=4
url: https://github.com/euri10
-- login: Xewus
- count: 13
- avatarUrl: https://avatars.githubusercontent.com/u/85196001?u=f8e2dc7e5104f109cef944af79050ea8d1b8f914&v=4
- url: https://github.com/Xewus
- login: mariacamilagl
count: 12
avatarUrl: https://avatars.githubusercontent.com/u/11489395?u=4adb6986bf3debfc2b8216ae701f2bd47d73da7d&v=4
@@ -307,6 +299,10 @@ top_contributors:
count: 5
avatarUrl: https://avatars.githubusercontent.com/u/43503750?u=f440bc9062afb3c43b9b9c6cdfdcfe31d58699ef&v=4
url: https://github.com/ComicShrimp
+- login: tamtam-fitness
+ count: 5
+ avatarUrl: https://avatars.githubusercontent.com/u/62091034?u=8da19a6bd3d02f5d6ba30c7247d5b46c98dd1403&v=4
+ url: https://github.com/tamtam-fitness
- login: jekirl
count: 4
avatarUrl: https://avatars.githubusercontent.com/u/2546697?u=a027452387d85bd4a14834e19d716c99255fb3b7&v=4
@@ -347,19 +343,27 @@ top_contributors:
count: 4
avatarUrl: https://avatars.githubusercontent.com/u/36765187?u=c6e0ba571c1ccb6db9d94e62e4b8b5eda811a870&v=4
url: https://github.com/ivan-abc
+- login: rostik1410
+ count: 4
+ avatarUrl: https://avatars.githubusercontent.com/u/11443899?u=e26a635c2ba220467b308a326a579b8ccf4a8701&v=4
+ url: https://github.com/rostik1410
top_reviewers:
- login: Kludex
- count: 136
+ count: 139
avatarUrl: https://avatars.githubusercontent.com/u/7353520?u=62adc405ef418f4b6c8caa93d3eb8ab107bc4927&v=4
url: https://github.com/Kludex
+- login: yezz123
+ count: 80
+ avatarUrl: https://avatars.githubusercontent.com/u/52716203?u=d7062cbc6eb7671d5dc9cc0e32a24ae335e0f225&v=4
+ url: https://github.com/yezz123
- login: BilalAlpaslan
count: 79
avatarUrl: https://avatars.githubusercontent.com/u/47563997?u=63ed66e304fe8d765762c70587d61d9196e5c82d&v=4
url: https://github.com/BilalAlpaslan
-- login: yezz123
- count: 78
- avatarUrl: https://avatars.githubusercontent.com/u/52716203?u=d7062cbc6eb7671d5dc9cc0e32a24ae335e0f225&v=4
- url: https://github.com/yezz123
+- login: iudeen
+ count: 54
+ avatarUrl: https://avatars.githubusercontent.com/u/10519440?u=2843b3303282bff8b212dcd4d9d6689452e4470c&v=4
+ url: https://github.com/iudeen
- login: tokusumi
count: 51
avatarUrl: https://avatars.githubusercontent.com/u/41147016?u=55010621aece725aa702270b54fed829b6a1fe60&v=4
@@ -372,22 +376,18 @@ top_reviewers:
count: 47
avatarUrl: https://avatars.githubusercontent.com/u/59285379?v=4
url: https://github.com/Laineyzhang55
-- login: iudeen
- count: 46
- avatarUrl: https://avatars.githubusercontent.com/u/10519440?u=2843b3303282bff8b212dcd4d9d6689452e4470c&v=4
- url: https://github.com/iudeen
- login: ycd
count: 45
avatarUrl: https://avatars.githubusercontent.com/u/62724709?u=bba5af018423a2858d49309bed2a899bb5c34ac5&v=4
url: https://github.com/ycd
+- login: Xewus
+ count: 44
+ avatarUrl: https://avatars.githubusercontent.com/u/85196001?u=f8e2dc7e5104f109cef944af79050ea8d1b8f914&v=4
+ url: https://github.com/Xewus
- login: cikay
count: 41
avatarUrl: https://avatars.githubusercontent.com/u/24587499?u=e772190a051ab0eaa9c8542fcff1892471638f2b&v=4
url: https://github.com/cikay
-- login: Xewus
- count: 38
- avatarUrl: https://avatars.githubusercontent.com/u/85196001?u=f8e2dc7e5104f109cef944af79050ea8d1b8f914&v=4
- url: https://github.com/Xewus
- login: JarroVGIT
count: 34
avatarUrl: https://avatars.githubusercontent.com/u/13659033?u=e8bea32d07a5ef72f7dde3b2079ceb714923ca05&v=4
@@ -460,6 +460,10 @@ top_reviewers:
count: 16
avatarUrl: https://avatars.githubusercontent.com/u/1334088?u=9667041f5b15dc002b6f9665fda8c0412933ac04&v=4
url: https://github.com/axel584
+- login: Alexandrhub
+ count: 16
+ avatarUrl: https://avatars.githubusercontent.com/u/119126536?u=9fc0d48f3307817bafecc5861eb2168401a6cb04&v=4
+ url: https://github.com/Alexandrhub
- login: DevDae
count: 16
avatarUrl: https://avatars.githubusercontent.com/u/87962045?u=08e10fa516e844934f4b3fc7c38b33c61697e4a1&v=4
@@ -472,18 +476,18 @@ top_reviewers:
count: 15
avatarUrl: https://avatars.githubusercontent.com/u/63476957?u=6c86e59b48e0394d4db230f37fc9ad4d7e2c27c7&v=4
url: https://github.com/delhi09
-- login: Alexandrhub
- count: 15
- avatarUrl: https://avatars.githubusercontent.com/u/119126536?u=9fc0d48f3307817bafecc5861eb2168401a6cb04&v=4
- url: https://github.com/Alexandrhub
- login: sh0nk
count: 13
avatarUrl: https://avatars.githubusercontent.com/u/6478810?u=af15d724875cec682ed8088a86d36b2798f981c0&v=4
url: https://github.com/sh0nk
- login: peidrao
count: 13
- avatarUrl: https://avatars.githubusercontent.com/u/32584628?u=5b94b548ef0002ef3219d7c07ac0fac17c6201a2&v=4
+ avatarUrl: https://avatars.githubusercontent.com/u/32584628?u=a66902b40c13647d0ed0e573d598128240a4dd04&v=4
url: https://github.com/peidrao
+- login: wdh99
+ count: 13
+ avatarUrl: https://avatars.githubusercontent.com/u/108172295?u=8a8fb95d5afe3e0fa33257b2aecae88d436249eb&v=4
+ url: https://github.com/wdh99
- login: r0b2g1t
count: 13
avatarUrl: https://avatars.githubusercontent.com/u/5357541?u=6428442d875d5d71aaa1bb38bb11c4be1a526bc2&v=4
@@ -500,10 +504,6 @@ top_reviewers:
count: 11
avatarUrl: https://avatars.githubusercontent.com/u/46193920?u=789927ee09cfabd752d3bd554fa6baf4850d2777&v=4
url: https://github.com/solomein-sv
-- login: wdh99
- count: 11
- avatarUrl: https://avatars.githubusercontent.com/u/108172295?u=8a8fb95d5afe3e0fa33257b2aecae88d436249eb&v=4
- url: https://github.com/wdh99
- login: mariacamilagl
count: 10
avatarUrl: https://avatars.githubusercontent.com/u/11489395?u=4adb6986bf3debfc2b8216ae701f2bd47d73da7d&v=4
diff --git a/docs/en/data/sponsors.yml b/docs/en/data/sponsors.yml
index 53cdb9bad..dac47d2f0 100644
--- a/docs/en/data/sponsors.yml
+++ b/docs/en/data/sponsors.yml
@@ -8,6 +8,12 @@ gold:
- url: https://www.buildwithfern.com/?utm_source=tiangolo&utm_medium=website&utm_campaign=main-badge
title: Fern | SDKs and API docs
img: https://fastapi.tiangolo.com/img/sponsors/fern.svg
+ - url: https://www.porter.run
+ title: Deploy FastAPI on AWS with a few clicks
+ img: https://fastapi.tiangolo.com/img/sponsors/porter.png
+ - url: https://bump.sh/fastapi?utm_source=fastapi&utm_medium=referral&utm_campaign=sponsor
+ title: Automate FastAPI documentation generation with Bump.sh
+ img: https://fastapi.tiangolo.com/img/sponsors/bump-sh.svg
silver:
- url: https://www.deta.sh/?ref=fastapi
title: The launchpad for all your (team's) ideas
@@ -24,16 +30,19 @@ silver:
- url: https://careers.powens.com/
title: Powens is hiring!
img: https://fastapi.tiangolo.com/img/sponsors/powens.png
- - url: https://www.svix.com/
- title: Svix - Webhooks as a service
- img: https://fastapi.tiangolo.com/img/sponsors/svix.svg
- url: https://databento.com/
title: Pay as you go for market data
img: https://fastapi.tiangolo.com/img/sponsors/databento.svg
+ - url: https://speakeasyapi.dev?utm_source=fastapi+repo&utm_medium=github+sponsorship
+ title: SDKs for your API | Speakeasy
+ img: https://fastapi.tiangolo.com/img/sponsors/speakeasy.png
+ - url: https://www.svix.com/
+ title: Svix - Webhooks as a service
+ img: https://fastapi.tiangolo.com/img/sponsors/svix.svg
bronze:
- url: https://www.exoflare.com/open-source/?utm_source=FastAPI&utm_campaign=open_source
title: Biosecurity risk assessments made easy.
img: https://fastapi.tiangolo.com/img/sponsors/exoflare.png
- - url: https://www.flint.sh
- title: IT expertise, consulting and development by passionate people
- img: https://fastapi.tiangolo.com/img/sponsors/flint.png
+ - url: https://bit.ly/3JJ7y5C
+ title: Build cross-modal and multimodal applications on the cloud
+ img: https://fastapi.tiangolo.com/img/sponsors/jina2.svg
diff --git a/docs/en/data/sponsors_badge.yml b/docs/en/data/sponsors_badge.yml
index b3cb06327..d67e27c87 100644
--- a/docs/en/data/sponsors_badge.yml
+++ b/docs/en/data/sponsors_badge.yml
@@ -12,8 +12,11 @@ logins:
- ObliviousAI
- Doist
- nihpo
- - svix
- armand-sauzay
- databento-bot
- nanram22
- Flint-company
+ - porter-dev
+ - fern-api
+ - ndimares
+ - svixhq
diff --git a/docs/en/docs/about/index.md b/docs/en/docs/about/index.md
new file mode 100644
index 000000000..27b78696b
--- /dev/null
+++ b/docs/en/docs/about/index.md
@@ -0,0 +1,3 @@
+# About
+
+About FastAPI, its design, inspiration and more. ๐ค
diff --git a/docs/en/docs/advanced/additional-status-codes.md b/docs/en/docs/advanced/additional-status-codes.md
index 416444d3b..0ce275343 100644
--- a/docs/en/docs/advanced/additional-status-codes.md
+++ b/docs/en/docs/advanced/additional-status-codes.md
@@ -26,7 +26,7 @@ To achieve that, import `JSONResponse`, and return your content there directly,
{!> ../../../docs_src/additional_status_codes/tutorial001_an_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="4 26"
{!> ../../../docs_src/additional_status_codes/tutorial001_an.py!}
@@ -41,7 +41,7 @@ To achieve that, import `JSONResponse`, and return your content there directly,
{!> ../../../docs_src/additional_status_codes/tutorial001_py310.py!}
```
-=== "Python 3.6+ non-Annotated"
+=== "Python 3.8+ non-Annotated"
!!! tip
Prefer to use the `Annotated` version if possible.
diff --git a/docs/en/docs/advanced/advanced-dependencies.md b/docs/en/docs/advanced/advanced-dependencies.md
index 402c5d755..0cffab56d 100644
--- a/docs/en/docs/advanced/advanced-dependencies.md
+++ b/docs/en/docs/advanced/advanced-dependencies.md
@@ -24,13 +24,13 @@ To do that, we declare a method `__call__`:
{!> ../../../docs_src/dependencies/tutorial011_an_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="11"
{!> ../../../docs_src/dependencies/tutorial011_an.py!}
```
-=== "Python 3.6+ non-Annotated"
+=== "Python 3.8+ non-Annotated"
!!! tip
Prefer to use the `Annotated` version if possible.
@@ -51,13 +51,13 @@ And now, we can use `__init__` to declare the parameters of the instance that we
{!> ../../../docs_src/dependencies/tutorial011_an_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="8"
{!> ../../../docs_src/dependencies/tutorial011_an.py!}
```
-=== "Python 3.6+ non-Annotated"
+=== "Python 3.8+ non-Annotated"
!!! tip
Prefer to use the `Annotated` version if possible.
@@ -78,13 +78,13 @@ We could create an instance of this class with:
{!> ../../../docs_src/dependencies/tutorial011_an_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="17"
{!> ../../../docs_src/dependencies/tutorial011_an.py!}
```
-=== "Python 3.6+ non-Annotated"
+=== "Python 3.8+ non-Annotated"
!!! tip
Prefer to use the `Annotated` version if possible.
@@ -113,13 +113,13 @@ checker(q="somequery")
{!> ../../../docs_src/dependencies/tutorial011_an_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="21"
{!> ../../../docs_src/dependencies/tutorial011_an.py!}
```
-=== "Python 3.6+ non-Annotated"
+=== "Python 3.8+ non-Annotated"
!!! tip
Prefer to use the `Annotated` version if possible.
diff --git a/docs/en/docs/advanced/extending-openapi.md b/docs/en/docs/advanced/extending-openapi.md
deleted file mode 100644
index bec184dee..000000000
--- a/docs/en/docs/advanced/extending-openapi.md
+++ /dev/null
@@ -1,318 +0,0 @@
-# Extending OpenAPI
-
-!!! warning
- This is a rather advanced feature. You probably can skip it.
-
- If you are just following the tutorial - user guide, you can probably skip this section.
-
- If you already know that you need to modify the generated OpenAPI schema, continue reading.
-
-There are some cases where you might need to modify the generated OpenAPI schema.
-
-In this section you will see how.
-
-## The normal process
-
-The normal (default) process, is as follows.
-
-A `FastAPI` application (instance) has an `.openapi()` method that is expected to return the OpenAPI schema.
-
-As part of the application object creation, a *path operation* for `/openapi.json` (or for whatever you set your `openapi_url`) is registered.
-
-It just returns a JSON response with the result of the application's `.openapi()` method.
-
-By default, what the method `.openapi()` does is check the property `.openapi_schema` to see if it has contents and return them.
-
-If it doesn't, it generates them using the utility function at `fastapi.openapi.utils.get_openapi`.
-
-And that function `get_openapi()` receives as parameters:
-
-* `title`: The OpenAPI title, shown in the docs.
-* `version`: The version of your API, e.g. `2.5.0`.
-* `openapi_version`: The version of the OpenAPI specification used. By default, the latest: `3.1.0`.
-* `summary`: A short summary of the API.
-* `description`: The description of your API, this can include markdown and will be shown in the docs.
-* `routes`: A list of routes, these are each of the registered *path operations*. They are taken from `app.routes`.
-
-!!! info
- The parameter `summary` is available in OpenAPI 3.1.0 and above, supported by FastAPI 0.99.0 and above.
-
-## Overriding the defaults
-
-Using the information above, you can use the same utility function to generate the OpenAPI schema and override each part that you need.
-
-For example, let's add ReDoc's OpenAPI extension to include a custom logo.
-
-### Normal **FastAPI**
-
-First, write all your **FastAPI** application as normally:
-
-```Python hl_lines="1 4 7-9"
-{!../../../docs_src/extending_openapi/tutorial001.py!}
-```
-
-### Generate the OpenAPI schema
-
-Then, use the same utility function to generate the OpenAPI schema, inside a `custom_openapi()` function:
-
-```Python hl_lines="2 15-21"
-{!../../../docs_src/extending_openapi/tutorial001.py!}
-```
-
-### Modify the OpenAPI schema
-
-Now you can add the ReDoc extension, adding a custom `x-logo` to the `info` "object" in the OpenAPI schema:
-
-```Python hl_lines="22-24"
-{!../../../docs_src/extending_openapi/tutorial001.py!}
-```
-
-### Cache the OpenAPI schema
-
-You can use the property `.openapi_schema` as a "cache", to store your generated schema.
-
-That way, your application won't have to generate the schema every time a user opens your API docs.
-
-It will be generated only once, and then the same cached schema will be used for the next requests.
-
-```Python hl_lines="13-14 25-26"
-{!../../../docs_src/extending_openapi/tutorial001.py!}
-```
-
-### Override the method
-
-Now you can replace the `.openapi()` method with your new function.
-
-```Python hl_lines="29"
-{!../../../docs_src/extending_openapi/tutorial001.py!}
-```
-
-### Check it
-
-Once you go to http://127.0.0.1:8000/redoc you will see that you are using your custom logo (in this example, **FastAPI**'s logo):
-
-
-
-## Self-hosting JavaScript and CSS for docs
-
-The API docs use **Swagger UI** and **ReDoc**, and each of those need some JavaScript and CSS files.
-
-By default, those files are served from a CDN.
-
-But it's possible to customize it, you can set a specific CDN, or serve the files yourself.
-
-That's useful, for example, if you need your app to keep working even while offline, without open Internet access, or in a local network.
-
-Here you'll see how to serve those files yourself, in the same FastAPI app, and configure the docs to use them.
-
-### Project file structure
-
-Let's say your project file structure looks like this:
-
-```
-.
-โโโ app
-โ โโโ __init__.py
-โ โโโ main.py
-```
-
-Now create a directory to store those static files.
-
-Your new file structure could look like this:
-
-```
-.
-โโโ app
-โย ย โโโ __init__.py
-โย ย โโโ main.py
-โโโ static/
-```
-
-### Download the files
-
-Download the static files needed for the docs and put them on that `static/` directory.
-
-You can probably right-click each link and select an option similar to `Save link as...`.
-
-**Swagger UI** uses the files:
-
-* `swagger-ui-bundle.js`
-* `swagger-ui.css`
-
-And **ReDoc** uses the file:
-
-* `redoc.standalone.js`
-
-After that, your file structure could look like:
-
-```
-.
-โโโ app
-โย ย โโโ __init__.py
-โย ย โโโ main.py
-โโโ static
- โโโ redoc.standalone.js
- โโโ swagger-ui-bundle.js
- โโโ swagger-ui.css
-```
-
-### Serve the static files
-
-* Import `StaticFiles`.
-* "Mount" a `StaticFiles()` instance in a specific path.
-
-```Python hl_lines="7 11"
-{!../../../docs_src/extending_openapi/tutorial002.py!}
-```
-
-### Test the static files
-
-Start your application and go to http://127.0.0.1:8000/static/redoc.standalone.js.
-
-You should see a very long JavaScript file for **ReDoc**.
-
-It could start with something like:
-
-```JavaScript
-/*!
- * ReDoc - OpenAPI/Swagger-generated API Reference Documentation
- * -------------------------------------------------------------
- * Version: "2.0.0-rc.18"
- * Repo: https://github.com/Redocly/redoc
- */
-!function(e,t){"object"==typeof exports&&"object"==typeof m
-
-...
-```
-
-That confirms that you are being able to serve static files from your app, and that you placed the static files for the docs in the correct place.
-
-Now we can configure the app to use those static files for the docs.
-
-### Disable the automatic docs
-
-The first step is to disable the automatic docs, as those use the CDN by default.
-
-To disable them, set their URLs to `None` when creating your `FastAPI` app:
-
-```Python hl_lines="9"
-{!../../../docs_src/extending_openapi/tutorial002.py!}
-```
-
-### Include the custom docs
-
-Now you can create the *path operations* for the custom docs.
-
-You can re-use FastAPI's internal functions to create the HTML pages for the docs, and pass them the needed arguments:
-
-* `openapi_url`: the URL where the HTML page for the docs can get the OpenAPI schema for your API. You can use here the attribute `app.openapi_url`.
-* `title`: the title of your API.
-* `oauth2_redirect_url`: you can use `app.swagger_ui_oauth2_redirect_url` here to use the default.
-* `swagger_js_url`: the URL where the HTML for your Swagger UI docs can get the **JavaScript** file. This is the one that your own app is now serving.
-* `swagger_css_url`: the URL where the HTML for your Swagger UI docs can get the **CSS** file. This is the one that your own app is now serving.
-
-And similarly for ReDoc...
-
-```Python hl_lines="2-6 14-22 25-27 30-36"
-{!../../../docs_src/extending_openapi/tutorial002.py!}
-```
-
-!!! tip
- The *path operation* for `swagger_ui_redirect` is a helper for when you use OAuth2.
-
- If you integrate your API with an OAuth2 provider, you will be able to authenticate and come back to the API docs with the acquired credentials. And interact with it using the real OAuth2 authentication.
-
- Swagger UI will handle it behind the scenes for you, but it needs this "redirect" helper.
-
-### Create a *path operation* to test it
-
-Now, to be able to test that everything works, create a *path operation*:
-
-```Python hl_lines="39-41"
-{!../../../docs_src/extending_openapi/tutorial002.py!}
-```
-
-### Test it
-
-Now, you should be able to disconnect your WiFi, go to your docs at http://127.0.0.1:8000/docs, and reload the page.
-
-And even without Internet, you would be able to see the docs for your API and interact with it.
-
-## Configuring Swagger UI
-
-You can configure some extra Swagger UI parameters.
-
-To configure them, pass the `swagger_ui_parameters` argument when creating the `FastAPI()` app object or to the `get_swagger_ui_html()` function.
-
-`swagger_ui_parameters` receives a dictionary with the configurations passed to Swagger UI directly.
-
-FastAPI converts the configurations to **JSON** to make them compatible with JavaScript, as that's what Swagger UI needs.
-
-### Disable Syntax Highlighting
-
-For example, you could disable syntax highlighting in Swagger UI.
-
-Without changing the settings, syntax highlighting is enabled by default:
-
-
-
-But you can disable it by setting `syntaxHighlight` to `False`:
-
-```Python hl_lines="3"
-{!../../../docs_src/extending_openapi/tutorial003.py!}
-```
-
-...and then Swagger UI won't show the syntax highlighting anymore:
-
-
-
-### Change the Theme
-
-The same way you could set the syntax highlighting theme with the key `"syntaxHighlight.theme"` (notice that it has a dot in the middle):
-
-```Python hl_lines="3"
-{!../../../docs_src/extending_openapi/tutorial004.py!}
-```
-
-That configuration would change the syntax highlighting color theme:
-
-
-
-### Change Default Swagger UI Parameters
-
-FastAPI includes some default configuration parameters appropriate for most of the use cases.
-
-It includes these default configurations:
-
-```Python
-{!../../../fastapi/openapi/docs.py[ln:7-13]!}
-```
-
-You can override any of them by setting a different value in the argument `swagger_ui_parameters`.
-
-For example, to disable `deepLinking` you could pass these settings to `swagger_ui_parameters`:
-
-```Python hl_lines="3"
-{!../../../docs_src/extending_openapi/tutorial005.py!}
-```
-
-### Other Swagger UI Parameters
-
-To see all the other possible configurations you can use, read the official docs for Swagger UI parameters.
-
-### JavaScript-only settings
-
-Swagger UI also allows other configurations to be **JavaScript-only** objects (for example, JavaScript functions).
-
-FastAPI also includes these JavaScript-only `presets` settings:
-
-```JavaScript
-presets: [
- SwaggerUIBundle.presets.apis,
- SwaggerUIBundle.SwaggerUIStandalonePreset
-]
-```
-
-These are **JavaScript** objects, not strings, so you can't pass them from Python code directly.
-
-If you need to use JavaScript-only configurations like those, you can use one of the methods above. Override all the Swagger UI *path operation* and manually write any JavaScript you need.
diff --git a/docs/en/docs/advanced/generate-clients.md b/docs/en/docs/advanced/generate-clients.md
index 3fed48b0b..07a8f039f 100644
--- a/docs/en/docs/advanced/generate-clients.md
+++ b/docs/en/docs/advanced/generate-clients.md
@@ -12,10 +12,18 @@ A common tool is openapi-typescript-codegen.
-Another option you could consider for several languages is Fern.
+## Client and SDK Generators - Sponsor
-!!! info
- Fern is also a FastAPI sponsor. ๐๐
+There are also some **company-backed** Client and SDK generators based on OpenAPI (FastAPI), in some cases they can offer you **additional features** on top of high-quality generated SDKs/clients.
+
+Some of them also โจ [**sponsor FastAPI**](../help-fastapi.md#sponsor-the-author){.internal-link target=_blank} โจ, this ensures the continued and healthy **development** of FastAPI and its **ecosystem**.
+
+And it shows their true commitment to FastAPI and its **community** (you), as they not only want to provide you a **good service** but also want to make sure you have a **good and healthy framework**, FastAPI. ๐
+
+You might want to try their services and follow their guides:
+
+* Fern
+* Speakeasy
## Generate a TypeScript Frontend Client
@@ -27,7 +35,7 @@ Let's start with a simple FastAPI application:
{!> ../../../docs_src/generate_clients/tutorial001_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="9-11 14-15 18 19 23"
{!> ../../../docs_src/generate_clients/tutorial001.py!}
@@ -139,7 +147,7 @@ For example, you could have a section for **items** and another section for **us
{!> ../../../docs_src/generate_clients/tutorial002_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="23 28 36"
{!> ../../../docs_src/generate_clients/tutorial002.py!}
@@ -196,7 +204,7 @@ You can then pass that custom function to **FastAPI** as the `generate_unique_id
{!> ../../../docs_src/generate_clients/tutorial003_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="8-9 12"
{!> ../../../docs_src/generate_clients/tutorial003.py!}
diff --git a/docs/en/docs/advanced/index.md b/docs/en/docs/advanced/index.md
index 467f0833e..d8dcd4ca6 100644
--- a/docs/en/docs/advanced/index.md
+++ b/docs/en/docs/advanced/index.md
@@ -17,8 +17,17 @@ You could still use most of the features in **FastAPI** with the knowledge from
And the next sections assume you already read it, and assume that you know those main ideas.
-## TestDriven.io course
+## External Courses
-If you would like to take an advanced-beginner course to complement this section of the docs, you might want to check: Test-Driven Development with FastAPI and Docker by **TestDriven.io**.
+Although the [Tutorial - User Guide](../tutorial/){.internal-link target=_blank} and this **Advanced User Guide** are written as a guided tutorial (like a book) and should be enough for you to **learn FastAPI**, you might want to complement it with additional courses.
-They are currently donating 10% of all profits to the development of **FastAPI**. ๐ ๐
+Or it might be the case that you just prefer to take other courses because they adapt better to your learning style.
+
+Some course providers โจ [**sponsor FastAPI**](../help-fastapi.md#sponsor-the-author){.internal-link target=_blank} โจ, this ensures the continued and healthy **development** of FastAPI and its **ecosystem**.
+
+And it shows their true commitment to FastAPI and its **community** (you), as they not only want to provide you a **good learning experience** but also want to make sure you have a **good and healthy framework**, FastAPI. ๐
+
+You might want to try their courses:
+
+* Talk Python Training
+* Test-Driven Development
diff --git a/docs/en/docs/advanced/security/http-basic-auth.md b/docs/en/docs/advanced/security/http-basic-auth.md
index 8177a4b28..6f9002f60 100644
--- a/docs/en/docs/advanced/security/http-basic-auth.md
+++ b/docs/en/docs/advanced/security/http-basic-auth.md
@@ -26,13 +26,13 @@ Then, when you type that username and password, the browser sends them in the he
{!> ../../../docs_src/security/tutorial006_an_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="2 7 11"
{!> ../../../docs_src/security/tutorial006_an.py!}
```
-=== "Python 3.6+ non-Annotated"
+=== "Python 3.8+ non-Annotated"
!!! tip
Prefer to use the `Annotated` version if possible.
@@ -65,13 +65,13 @@ Then we can use `secrets.compare_digest()` to ensure that `credentials.username`
{!> ../../../docs_src/security/tutorial007_an_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="1 12-24"
{!> ../../../docs_src/security/tutorial007_an.py!}
```
-=== "Python 3.6+ non-Annotated"
+=== "Python 3.8+ non-Annotated"
!!! tip
Prefer to use the `Annotated` version if possible.
@@ -148,13 +148,13 @@ After detecting that the credentials are incorrect, return an `HTTPException` wi
{!> ../../../docs_src/security/tutorial007_an_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="26-30"
{!> ../../../docs_src/security/tutorial007_an.py!}
```
-=== "Python 3.6+ non-Annotated"
+=== "Python 3.8+ non-Annotated"
!!! tip
Prefer to use the `Annotated` version if possible.
diff --git a/docs/en/docs/advanced/security/oauth2-scopes.md b/docs/en/docs/advanced/security/oauth2-scopes.md
index 41cd61683..304a46090 100644
--- a/docs/en/docs/advanced/security/oauth2-scopes.md
+++ b/docs/en/docs/advanced/security/oauth2-scopes.md
@@ -68,7 +68,7 @@ First, let's quickly see the parts that change from the examples in the main **T
{!> ../../../docs_src/security/tutorial005_an_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="2 4 8 12 47 65 106 108-116 122-125 129-135 140 156"
{!> ../../../docs_src/security/tutorial005_an.py!}
@@ -92,7 +92,7 @@ First, let's quickly see the parts that change from the examples in the main **T
{!> ../../../docs_src/security/tutorial005_py39.py!}
```
-=== "Python 3.6+ non-Annotated"
+=== "Python 3.8+ non-Annotated"
!!! tip
Prefer to use the `Annotated` version if possible.
@@ -121,7 +121,7 @@ The `scopes` parameter receives a `dict` with each scope as a key and the descri
{!> ../../../docs_src/security/tutorial005_an_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="63-66"
{!> ../../../docs_src/security/tutorial005_an.py!}
@@ -146,7 +146,7 @@ The `scopes` parameter receives a `dict` with each scope as a key and the descri
{!> ../../../docs_src/security/tutorial005_py39.py!}
```
-=== "Python 3.6+ non-Annotated"
+=== "Python 3.8+ non-Annotated"
!!! tip
Prefer to use the `Annotated` version if possible.
@@ -188,7 +188,7 @@ And we return the scopes as part of the JWT token.
{!> ../../../docs_src/security/tutorial005_an_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="156"
{!> ../../../docs_src/security/tutorial005_an.py!}
@@ -212,7 +212,7 @@ And we return the scopes as part of the JWT token.
{!> ../../../docs_src/security/tutorial005_py39.py!}
```
-=== "Python 3.6+ non-Annotated"
+=== "Python 3.8+ non-Annotated"
!!! tip
Prefer to use the `Annotated` version if possible.
@@ -254,7 +254,7 @@ In this case, it requires the scope `me` (it could require more than one scope).
{!> ../../../docs_src/security/tutorial005_an_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="4 140 171"
{!> ../../../docs_src/security/tutorial005_an.py!}
@@ -278,7 +278,7 @@ In this case, it requires the scope `me` (it could require more than one scope).
{!> ../../../docs_src/security/tutorial005_py39.py!}
```
-=== "Python 3.6+ non-Annotated"
+=== "Python 3.8+ non-Annotated"
!!! tip
Prefer to use the `Annotated` version if possible.
@@ -320,7 +320,7 @@ This `SecurityScopes` class is similar to `Request` (`Request` was used to get t
{!> ../../../docs_src/security/tutorial005_an_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="8 106"
{!> ../../../docs_src/security/tutorial005_an.py!}
@@ -344,7 +344,7 @@ This `SecurityScopes` class is similar to `Request` (`Request` was used to get t
{!> ../../../docs_src/security/tutorial005_py39.py!}
```
-=== "Python 3.6+ non-Annotated"
+=== "Python 3.8+ non-Annotated"
!!! tip
Prefer to use the `Annotated` version if possible.
@@ -377,7 +377,7 @@ In this exception, we include the scopes required (if any) as a string separated
{!> ../../../docs_src/security/tutorial005_an_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="106 108-116"
{!> ../../../docs_src/security/tutorial005_an.py!}
@@ -401,7 +401,7 @@ In this exception, we include the scopes required (if any) as a string separated
{!> ../../../docs_src/security/tutorial005_py39.py!}
```
-=== "Python 3.6+ non-Annotated"
+=== "Python 3.8+ non-Annotated"
!!! tip
Prefer to use the `Annotated` version if possible.
@@ -436,7 +436,7 @@ We also verify that we have a user with that username, and if not, we raise that
{!> ../../../docs_src/security/tutorial005_an_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="47 117-128"
{!> ../../../docs_src/security/tutorial005_an.py!}
@@ -460,7 +460,7 @@ We also verify that we have a user with that username, and if not, we raise that
{!> ../../../docs_src/security/tutorial005_py39.py!}
```
-=== "Python 3.6+ non-Annotated"
+=== "Python 3.8+ non-Annotated"
!!! tip
Prefer to use the `Annotated` version if possible.
@@ -487,7 +487,7 @@ For this, we use `security_scopes.scopes`, that contains a `list` with all these
{!> ../../../docs_src/security/tutorial005_an_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="129-135"
{!> ../../../docs_src/security/tutorial005_an.py!}
@@ -511,7 +511,7 @@ For this, we use `security_scopes.scopes`, that contains a `list` with all these
{!> ../../../docs_src/security/tutorial005_py39.py!}
```
-=== "Python 3.6+ non-Annotated"
+=== "Python 3.8+ non-Annotated"
!!! tip
Prefer to use the `Annotated` version if possible.
diff --git a/docs/en/docs/advanced/settings.md b/docs/en/docs/advanced/settings.md
index 8f6c7da93..d39130777 100644
--- a/docs/en/docs/advanced/settings.md
+++ b/docs/en/docs/advanced/settings.md
@@ -260,13 +260,13 @@ Now we create a dependency that returns a new `config.Settings()`.
{!> ../../../docs_src/settings/app02_an_py39/main.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="6 12-13"
{!> ../../../docs_src/settings/app02_an/main.py!}
```
-=== "Python 3.6+ non-Annotated"
+=== "Python 3.8+ non-Annotated"
!!! tip
Prefer to use the `Annotated` version if possible.
@@ -288,13 +288,13 @@ And then we can require it from the *path operation function* as a dependency an
{!> ../../../docs_src/settings/app02_an_py39/main.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="17 19-21"
{!> ../../../docs_src/settings/app02_an/main.py!}
```
-=== "Python 3.6+ non-Annotated"
+=== "Python 3.8+ non-Annotated"
!!! tip
Prefer to use the `Annotated` version if possible.
@@ -396,13 +396,13 @@ But as we are using the `@lru_cache()` decorator on top, the `Settings` object w
{!> ../../../docs_src/settings/app03_an_py39/main.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="1 11"
{!> ../../../docs_src/settings/app03_an/main.py!}
```
-=== "Python 3.6+ non-Annotated"
+=== "Python 3.8+ non-Annotated"
!!! tip
Prefer to use the `Annotated` version if possible.
diff --git a/docs/en/docs/advanced/testing-dependencies.md b/docs/en/docs/advanced/testing-dependencies.md
index ee48a735d..57dd87f56 100644
--- a/docs/en/docs/advanced/testing-dependencies.md
+++ b/docs/en/docs/advanced/testing-dependencies.md
@@ -40,7 +40,7 @@ And then **FastAPI** will call that override instead of the original dependency.
{!> ../../../docs_src/dependency_testing/tutorial001_an_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="29-30 33"
{!> ../../../docs_src/dependency_testing/tutorial001_an.py!}
@@ -55,7 +55,7 @@ And then **FastAPI** will call that override instead of the original dependency.
{!> ../../../docs_src/dependency_testing/tutorial001_py310.py!}
```
-=== "Python 3.6+ non-Annotated"
+=== "Python 3.8+ non-Annotated"
!!! tip
Prefer to use the `Annotated` version if possible.
diff --git a/docs/en/docs/advanced/websockets.md b/docs/en/docs/advanced/websockets.md
index 94cf191d2..49b8fba89 100644
--- a/docs/en/docs/advanced/websockets.md
+++ b/docs/en/docs/advanced/websockets.md
@@ -124,7 +124,7 @@ They work the same way as for other FastAPI endpoints/*path operations*:
{!> ../../../docs_src/websockets/tutorial002_an_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="69-70 83"
{!> ../../../docs_src/websockets/tutorial002_an.py!}
@@ -139,7 +139,7 @@ They work the same way as for other FastAPI endpoints/*path operations*:
{!> ../../../docs_src/websockets/tutorial002_py310.py!}
```
-=== "Python 3.6+ non-Annotated"
+=== "Python 3.8+ non-Annotated"
!!! tip
Prefer to use the `Annotated` version if possible.
@@ -191,7 +191,7 @@ When a WebSocket connection is closed, the `await websocket.receive_text()` will
{!> ../../../docs_src/websockets/tutorial003_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="81-83"
{!> ../../../docs_src/websockets/tutorial003.py!}
diff --git a/docs/en/docs/css/custom.css b/docs/en/docs/css/custom.css
index 066b51725..187040792 100644
--- a/docs/en/docs/css/custom.css
+++ b/docs/en/docs/css/custom.css
@@ -144,3 +144,39 @@ code {
margin-top: 2em;
margin-bottom: 2em;
}
+
+/* Screenshots */
+/*
+Simulate a browser window frame.
+Inspired by Termynal's CSS tricks with modifications
+*/
+
+.screenshot {
+ display: block;
+ background-color: #d3e0de;
+ border-radius: 4px;
+ padding: 45px 5px 5px;
+ position: relative;
+ -webkit-box-sizing: border-box;
+ box-sizing: border-box;
+}
+
+.screenshot img {
+ display: block;
+ border-radius: 2px;
+}
+
+.screenshot:before {
+ content: '';
+ position: absolute;
+ top: 15px;
+ left: 15px;
+ display: inline-block;
+ width: 15px;
+ height: 15px;
+ border-radius: 50%;
+ /* A little hack to display the window buttons in one pseudo element. */
+ background: #d9515d;
+ -webkit-box-shadow: 25px 0 0 #f4c025, 50px 0 0 #3ec930;
+ box-shadow: 25px 0 0 #f4c025, 50px 0 0 #3ec930;
+}
diff --git a/docs/en/docs/deployment/cloud.md b/docs/en/docs/deployment/cloud.md
new file mode 100644
index 000000000..b2836aeb4
--- /dev/null
+++ b/docs/en/docs/deployment/cloud.md
@@ -0,0 +1,17 @@
+# Deploy FastAPI on Cloud Providers
+
+You can use virtually **any cloud provider** to deploy your FastAPI application.
+
+In most of the cases, the main cloud providers have guides to deploy FastAPI with them.
+
+## Cloud Providers - Sponsors
+
+Some cloud providers โจ [**sponsor FastAPI**](../help-fastapi.md#sponsor-the-author){.internal-link target=_blank} โจ, this ensures the continued and healthy **development** of FastAPI and its **ecosystem**.
+
+And it shows their true commitment to FastAPI and its **community** (you), as they not only want to provide you a **good service** but also want to make sure you have a **good and healthy framework**, FastAPI. ๐
+
+You might want to try their services and follow their guides:
+
+* Platform.sh
+* Porter
+* Deta
diff --git a/docs/en/docs/deployment/deta.md b/docs/en/docs/deployment/deta.md
deleted file mode 100644
index 229d7fd5d..000000000
--- a/docs/en/docs/deployment/deta.md
+++ /dev/null
@@ -1,391 +0,0 @@
-# Deploy FastAPI on Deta Space
-
-In this section you will learn how to easily deploy a **FastAPI** application on Deta Space, for free. ๐
-
-It will take you about **10 minutes** to deploy an API that you can use. After that, you can optionally release it to anyone.
-
-Let's dive in.
-
-!!! info
- Deta is a **FastAPI** sponsor. ๐
-
-## A simple **FastAPI** app
-
-* To start, create an empty directory with the name of your app, for example `./fastapi-deta/`, and then navigate into it.
-
-```console
-$ mkdir fastapi-deta
-$ cd fastapi-deta
-```
-
-### FastAPI code
-
-* Create a `main.py` file with:
-
-```Python
-from fastapi import FastAPI
-
-app = FastAPI()
-
-
-@app.get("/")
-def read_root():
- return {"Hello": "World"}
-
-
-@app.get("/items/{item_id}")
-def read_item(item_id: int):
- return {"item_id": item_id}
-```
-
-### Requirements
-
-Now, in the same directory create a file `requirements.txt` with:
-
-```text
-fastapi
-uvicorn[standard]
-```
-
-### Directory structure
-
-You will now have a directory `./fastapi-deta/` with two files:
-
-```
-.
-โโโ main.py
-โโโ requirements.txt
-```
-
-## Create a free **Deta Space** account
-
-Next, create a free account on Deta Space, you just need an email and password.
-
-You don't even need a credit card, but make sure **Developer Mode** is enabled when you sign up.
-
-
-## Install the CLI
-
-Once you have your account, install the Deta Space CLI:
-
-=== "Linux, macOS"
-
- 
-
-Now run `space login` from the Space CLI. Upon pasting the token into the CLI prompt and pressing enter, you should see a confirmation message.
-
-
-
-Click on the new app called `fastapi-deta`, and it will open your API in a new browser tab on a URL like `https://fastapi-deta-gj7ka8.deta.app/`.
-
-You will get a JSON response from your FastAPI app:
-
-```JSON
-{
- "Hello": "World"
-}
-```
-
-And now you can head over to the `/docs` of your API. For this example, it would be `https://fastapi-deta-gj7ka8.deta.app/docs`.
-
-
-
-## Enable public access
-
-Deta will handle authentication for your account using cookies. By default, every app or API that you `push` or install to your Space is personal - it's only accessible to you.
-
-But you can also make your API public using the `Spacefile` from earlier.
-
-With a `public_routes` parameter, you can specify which paths of your API should be available to the public.
-
-Set your `public_routes` to `"*"` to open every route of your API to the public:
-
-```yaml
-v: 0
-micros:
- - name: fastapi-deta
- src: .
- engine: python3.9
- public_routes:
- - "/*"
-```
-
-Then run `space push` again to update your live API on Deta Space.
-
-Once it deploys, you can share your URL with anyone and they will be able to access your API. ๐
-
-## HTTPS
-
-Congrats! You deployed your FastAPI app to Deta Space! ๐ ๐ฐ
-
-Also, notice that Deta Space correctly handles HTTPS for you, so you don't have to take care of that and can be sure that your users will have a secure encrypted connection. โ
๐
-
-## Create a release
-
-Space also allows you to publish your API. When you publish it, anyone else can install their own copy of your API, in their own Deta Space cloud.
-
-To do so, run `space release` in the Space CLI to create an **unlisted release**:
-
-
-
-## Learn more
-
-At some point, you will probably want to store some data for your app in a way that persists through time. For that you can use Deta Base and Deta Drive, both of which have a generous **free tier**.
-
-You can also read more in the Deta Space Documentation.
-
-!!! tip
- If you have any Deta related questions, comments, or feedback, head to the Deta Discord server.
-
-
-## Deployment Concepts
-
-Coming back to the concepts we discussed in [Deployments Concepts](./concepts.md){.internal-link target=_blank}, here's how each of them would be handled with Deta Space:
-
-- **HTTPS**: Handled by Deta Space, they will give you a subdomain and handle HTTPS automatically.
-- **Running on startup**: Handled by Deta Space, as part of their service.
-- **Restarts**: Handled by Deta Space, as part of their service.
-- **Replication**: Handled by Deta Space, as part of their service.
-- **Authentication**: Handled by Deta Space, as part of their service.
-- **Memory**: Limit predefined by Deta Space, you could contact them to increase it.
-- **Previous steps before starting**: Can be configured using the `Spacefile`.
-
-!!! note
- Deta Space is designed to make it easy and free to build cloud applications for yourself. Then you can optionally share them with anyone.
-
- It can simplify several use cases, but at the same time, it doesn't support others, like using external databases (apart from Deta's own NoSQL database system), custom virtual machines, etc.
-
- You can read more details in the Deta Space Documentation to see if it's the right choice for you.
diff --git a/docs/en/docs/deployment/server-workers.md b/docs/en/docs/deployment/server-workers.md
index 4ccd9d9f6..2df9f3d43 100644
--- a/docs/en/docs/deployment/server-workers.md
+++ b/docs/en/docs/deployment/server-workers.md
@@ -90,7 +90,9 @@ Let's see what each of those options mean:
```
* So, the colon in `main:app` would be equivalent to the Python `import` part in `from main import app`.
+
* `--workers`: The number of worker processes to use, each will run a Uvicorn worker, in this case, 4 workers.
+
* `--worker-class`: The Gunicorn-compatible worker class to use in the worker processes.
* Here we pass the class that Gunicorn can import and use with:
diff --git a/docs/en/docs/external-links.md b/docs/en/docs/external-links.md
index 0c91470bc..b89021ee2 100644
--- a/docs/en/docs/external-links.md
+++ b/docs/en/docs/external-links.md
@@ -9,79 +9,21 @@ Here's an incomplete list of some of them.
!!! tip
If you have an article, project, tool, or anything related to **FastAPI** that is not yet listed here, create a Pull Request adding it.
-## Articles
+{% for section_name, section_content in external_links.items() %}
-### English
+## {{ section_name }}
-{% if external_links %}
-{% for article in external_links.articles.english %}
+{% for lang_name, lang_content in section_content.items() %}
+
+### {{ lang_name }}
+
+{% for item in lang_content %}
+
+* {{ item.title }} by {{ item.author }}.
-* {{ article.title }} by {{ article.author }}.
{% endfor %}
-{% endif %}
-
-### Japanese
-
-{% if external_links %}
-{% for article in external_links.articles.japanese %}
-
-* {{ article.title }} by {{ article.author }}.
{% endfor %}
-{% endif %}
-
-### Vietnamese
-
-{% if external_links %}
-{% for article in external_links.articles.vietnamese %}
-
-* {{ article.title }} by {{ article.author }}.
{% endfor %}
-{% endif %}
-
-### Russian
-
-{% if external_links %}
-{% for article in external_links.articles.russian %}
-
-* {{ article.title }} by {{ article.author }}.
-{% endfor %}
-{% endif %}
-
-### German
-
-{% if external_links %}
-{% for article in external_links.articles.german %}
-
-* {{ article.title }} by {{ article.author }}.
-{% endfor %}
-{% endif %}
-
-### Taiwanese
-
-{% if external_links %}
-{% for article in external_links.articles.taiwanese %}
-
-* {{ article.title }} by {{ article.author }}.
-{% endfor %}
-{% endif %}
-
-## Podcasts
-
-{% if external_links %}
-{% for article in external_links.podcasts.english %}
-
-* {{ article.title }} by {{ article.author }}.
-{% endfor %}
-{% endif %}
-
-## Talks
-
-{% if external_links %}
-{% for article in external_links.talks.english %}
-
-* {{ article.title }} by {{ article.author }}.
-{% endfor %}
-{% endif %}
## Projects
diff --git a/docs/en/docs/fastapi-people.md b/docs/en/docs/fastapi-people.md
index 20caaa1ee..7e26358d8 100644
--- a/docs/en/docs/fastapi-people.md
+++ b/docs/en/docs/fastapi-people.md
@@ -1,3 +1,8 @@
+---
+hide:
+ - navigation
+---
+
# FastAPI People
FastAPI has an amazing community that welcomes people from all backgrounds.
diff --git a/docs/en/docs/features.md b/docs/en/docs/features.md
index 98f37b534..6f13b03bb 100644
--- a/docs/en/docs/features.md
+++ b/docs/en/docs/features.md
@@ -1,3 +1,8 @@
+---
+hide:
+ - navigation
+---
+
# Features
## FastAPI features
diff --git a/docs/en/docs/help-fastapi.md b/docs/en/docs/help-fastapi.md
index e977dba20..8199c9b9a 100644
--- a/docs/en/docs/help-fastapi.md
+++ b/docs/en/docs/help-fastapi.md
@@ -231,8 +231,6 @@ Join the ๐ฅ Gitter chat, but as it doesn't have channels and advanced features, conversations are more difficult, so Discord is now the recommended system.
-
### Don't use the chat for questions
Have in mind that as chats allow more "free conversation", it's easy to ask questions that are too general and more difficult to answer, so, you might not receive answers.
diff --git a/docs/en/docs/help/index.md b/docs/en/docs/help/index.md
new file mode 100644
index 000000000..5ee7df2fe
--- /dev/null
+++ b/docs/en/docs/help/index.md
@@ -0,0 +1,3 @@
+# Help
+
+Help and get help, contribute, get involved. ๐ค
diff --git a/docs/en/docs/advanced/async-sql-databases.md b/docs/en/docs/how-to/async-sql-encode-databases.md
similarity index 98%
rename from docs/en/docs/advanced/async-sql-databases.md
rename to docs/en/docs/how-to/async-sql-encode-databases.md
index 12549a190..697167f79 100644
--- a/docs/en/docs/advanced/async-sql-databases.md
+++ b/docs/en/docs/how-to/async-sql-encode-databases.md
@@ -1,4 +1,4 @@
-# Async SQL (Relational) Databases
+# Async SQL (Relational) Databases with Encode/Databases
!!! info
These docs are about to be updated. ๐
diff --git a/docs/en/docs/advanced/conditional-openapi.md b/docs/en/docs/how-to/conditional-openapi.md
similarity index 100%
rename from docs/en/docs/advanced/conditional-openapi.md
rename to docs/en/docs/how-to/conditional-openapi.md
diff --git a/docs/en/docs/how-to/configure-swagger-ui.md b/docs/en/docs/how-to/configure-swagger-ui.md
new file mode 100644
index 000000000..f36ba5ba8
--- /dev/null
+++ b/docs/en/docs/how-to/configure-swagger-ui.md
@@ -0,0 +1,78 @@
+# Configure Swagger UI
+
+You can configure some extra Swagger UI parameters.
+
+To configure them, pass the `swagger_ui_parameters` argument when creating the `FastAPI()` app object or to the `get_swagger_ui_html()` function.
+
+`swagger_ui_parameters` receives a dictionary with the configurations passed to Swagger UI directly.
+
+FastAPI converts the configurations to **JSON** to make them compatible with JavaScript, as that's what Swagger UI needs.
+
+## Disable Syntax Highlighting
+
+For example, you could disable syntax highlighting in Swagger UI.
+
+Without changing the settings, syntax highlighting is enabled by default:
+
+
+
+But you can disable it by setting `syntaxHighlight` to `False`:
+
+```Python hl_lines="3"
+{!../../../docs_src/configure_swagger_ui/tutorial001.py!}
+```
+
+...and then Swagger UI won't show the syntax highlighting anymore:
+
+
+
+## Change the Theme
+
+The same way you could set the syntax highlighting theme with the key `"syntaxHighlight.theme"` (notice that it has a dot in the middle):
+
+```Python hl_lines="3"
+{!../../../docs_src/configure_swagger_ui/tutorial002.py!}
+```
+
+That configuration would change the syntax highlighting color theme:
+
+
+
+## Change Default Swagger UI Parameters
+
+FastAPI includes some default configuration parameters appropriate for most of the use cases.
+
+It includes these default configurations:
+
+```Python
+{!../../../fastapi/openapi/docs.py[ln:7-13]!}
+```
+
+You can override any of them by setting a different value in the argument `swagger_ui_parameters`.
+
+For example, to disable `deepLinking` you could pass these settings to `swagger_ui_parameters`:
+
+```Python hl_lines="3"
+{!../../../docs_src/configure_swagger_ui/tutorial003.py!}
+```
+
+## Other Swagger UI Parameters
+
+To see all the other possible configurations you can use, read the official docs for Swagger UI parameters.
+
+## JavaScript-only settings
+
+Swagger UI also allows other configurations to be **JavaScript-only** objects (for example, JavaScript functions).
+
+FastAPI also includes these JavaScript-only `presets` settings:
+
+```JavaScript
+presets: [
+ SwaggerUIBundle.presets.apis,
+ SwaggerUIBundle.SwaggerUIStandalonePreset
+]
+```
+
+These are **JavaScript** objects, not strings, so you can't pass them from Python code directly.
+
+If you need to use JavaScript-only configurations like those, you can use one of the methods above. Override all the Swagger UI *path operation* and manually write any JavaScript you need.
diff --git a/docs/en/docs/how-to/custom-docs-ui-assets.md b/docs/en/docs/how-to/custom-docs-ui-assets.md
new file mode 100644
index 000000000..f26324869
--- /dev/null
+++ b/docs/en/docs/how-to/custom-docs-ui-assets.md
@@ -0,0 +1,199 @@
+# Custom Docs UI Static Assets (Self-Hosting)
+
+The API docs use **Swagger UI** and **ReDoc**, and each of those need some JavaScript and CSS files.
+
+By default, those files are served from a CDN.
+
+But it's possible to customize it, you can set a specific CDN, or serve the files yourself.
+
+## Custom CDN for JavaScript and CSS
+
+Let's say that you want to use a different CDN, for example you want to use `https://unpkg.com/`.
+
+This could be useful if for example you live in a country that restricts some URLs.
+
+### Disable the automatic docs
+
+The first step is to disable the automatic docs, as by default, those use the default CDN.
+
+To disable them, set their URLs to `None` when creating your `FastAPI` app:
+
+```Python hl_lines="8"
+{!../../../docs_src/custom_docs_ui/tutorial001.py!}
+```
+
+### Include the custom docs
+
+Now you can create the *path operations* for the custom docs.
+
+You can re-use FastAPI's internal functions to create the HTML pages for the docs, and pass them the needed arguments:
+
+* `openapi_url`: the URL where the HTML page for the docs can get the OpenAPI schema for your API. You can use here the attribute `app.openapi_url`.
+* `title`: the title of your API.
+* `oauth2_redirect_url`: you can use `app.swagger_ui_oauth2_redirect_url` here to use the default.
+* `swagger_js_url`: the URL where the HTML for your Swagger UI docs can get the **JavaScript** file. This is the custom CDN URL.
+* `swagger_css_url`: the URL where the HTML for your Swagger UI docs can get the **CSS** file. This is the custom CDN URL.
+
+And similarly for ReDoc...
+
+```Python hl_lines="2-6 11-19 22-24 27-33"
+{!../../../docs_src/custom_docs_ui/tutorial001.py!}
+```
+
+!!! tip
+ The *path operation* for `swagger_ui_redirect` is a helper for when you use OAuth2.
+
+ If you integrate your API with an OAuth2 provider, you will be able to authenticate and come back to the API docs with the acquired credentials. And interact with it using the real OAuth2 authentication.
+
+ Swagger UI will handle it behind the scenes for you, but it needs this "redirect" helper.
+
+### Create a *path operation* to test it
+
+Now, to be able to test that everything works, create a *path operation*:
+
+```Python hl_lines="36-38"
+{!../../../docs_src/custom_docs_ui/tutorial001.py!}
+```
+
+### Test it
+
+Now, you should be able to go to your docs at http://127.0.0.1:8000/docs, and reload the page, it will load those assets from the new CDN.
+
+## Self-hosting JavaScript and CSS for docs
+
+Self-hosting the JavaScript and CSS could be useful if, for example, you need your app to keep working even while offline, without open Internet access, or in a local network.
+
+Here you'll see how to serve those files yourself, in the same FastAPI app, and configure the docs to use them.
+
+### Project file structure
+
+Let's say your project file structure looks like this:
+
+```
+.
+โโโ app
+โ โโโ __init__.py
+โ โโโ main.py
+```
+
+Now create a directory to store those static files.
+
+Your new file structure could look like this:
+
+```
+.
+โโโ app
+โย ย โโโ __init__.py
+โย ย โโโ main.py
+โโโ static/
+```
+
+### Download the files
+
+Download the static files needed for the docs and put them on that `static/` directory.
+
+You can probably right-click each link and select an option similar to `Save link as...`.
+
+**Swagger UI** uses the files:
+
+* `swagger-ui-bundle.js`
+* `swagger-ui.css`
+
+And **ReDoc** uses the file:
+
+* `redoc.standalone.js`
+
+After that, your file structure could look like:
+
+```
+.
+โโโ app
+โย ย โโโ __init__.py
+โย ย โโโ main.py
+โโโ static
+ โโโ redoc.standalone.js
+ โโโ swagger-ui-bundle.js
+ โโโ swagger-ui.css
+```
+
+### Serve the static files
+
+* Import `StaticFiles`.
+* "Mount" a `StaticFiles()` instance in a specific path.
+
+```Python hl_lines="7 11"
+{!../../../docs_src/custom_docs_ui/tutorial002.py!}
+```
+
+### Test the static files
+
+Start your application and go to http://127.0.0.1:8000/static/redoc.standalone.js.
+
+You should see a very long JavaScript file for **ReDoc**.
+
+It could start with something like:
+
+```JavaScript
+/*!
+ * ReDoc - OpenAPI/Swagger-generated API Reference Documentation
+ * -------------------------------------------------------------
+ * Version: "2.0.0-rc.18"
+ * Repo: https://github.com/Redocly/redoc
+ */
+!function(e,t){"object"==typeof exports&&"object"==typeof m
+
+...
+```
+
+That confirms that you are being able to serve static files from your app, and that you placed the static files for the docs in the correct place.
+
+Now we can configure the app to use those static files for the docs.
+
+### Disable the automatic docs for static files
+
+The same as when using a custom CDN, the first step is to disable the automatic docs, as those use the CDN by default.
+
+To disable them, set their URLs to `None` when creating your `FastAPI` app:
+
+```Python hl_lines="9"
+{!../../../docs_src/custom_docs_ui/tutorial002.py!}
+```
+
+### Include the custom docs for static files
+
+And the same way as with a custom CDN, now you can create the *path operations* for the custom docs.
+
+Again, you can re-use FastAPI's internal functions to create the HTML pages for the docs, and pass them the needed arguments:
+
+* `openapi_url`: the URL where the HTML page for the docs can get the OpenAPI schema for your API. You can use here the attribute `app.openapi_url`.
+* `title`: the title of your API.
+* `oauth2_redirect_url`: you can use `app.swagger_ui_oauth2_redirect_url` here to use the default.
+* `swagger_js_url`: the URL where the HTML for your Swagger UI docs can get the **JavaScript** file. **This is the one that your own app is now serving**.
+* `swagger_css_url`: the URL where the HTML for your Swagger UI docs can get the **CSS** file. **This is the one that your own app is now serving**.
+
+And similarly for ReDoc...
+
+```Python hl_lines="2-6 14-22 25-27 30-36"
+{!../../../docs_src/custom_docs_ui/tutorial002.py!}
+```
+
+!!! tip
+ The *path operation* for `swagger_ui_redirect` is a helper for when you use OAuth2.
+
+ If you integrate your API with an OAuth2 provider, you will be able to authenticate and come back to the API docs with the acquired credentials. And interact with it using the real OAuth2 authentication.
+
+ Swagger UI will handle it behind the scenes for you, but it needs this "redirect" helper.
+
+### Create a *path operation* to test static files
+
+Now, to be able to test that everything works, create a *path operation*:
+
+```Python hl_lines="39-41"
+{!../../../docs_src/custom_docs_ui/tutorial002.py!}
+```
+
+### Test Static Files UI
+
+Now, you should be able to disconnect your WiFi, go to your docs at http://127.0.0.1:8000/docs, and reload the page.
+
+And even without Internet, you would be able to see the docs for your API and interact with it.
diff --git a/docs/en/docs/advanced/custom-request-and-route.md b/docs/en/docs/how-to/custom-request-and-route.md
similarity index 100%
rename from docs/en/docs/advanced/custom-request-and-route.md
rename to docs/en/docs/how-to/custom-request-and-route.md
diff --git a/docs/en/docs/how-to/extending-openapi.md b/docs/en/docs/how-to/extending-openapi.md
new file mode 100644
index 000000000..a18fd737e
--- /dev/null
+++ b/docs/en/docs/how-to/extending-openapi.md
@@ -0,0 +1,87 @@
+# Extending OpenAPI
+
+There are some cases where you might need to modify the generated OpenAPI schema.
+
+In this section you will see how.
+
+## The normal process
+
+The normal (default) process, is as follows.
+
+A `FastAPI` application (instance) has an `.openapi()` method that is expected to return the OpenAPI schema.
+
+As part of the application object creation, a *path operation* for `/openapi.json` (or for whatever you set your `openapi_url`) is registered.
+
+It just returns a JSON response with the result of the application's `.openapi()` method.
+
+By default, what the method `.openapi()` does is check the property `.openapi_schema` to see if it has contents and return them.
+
+If it doesn't, it generates them using the utility function at `fastapi.openapi.utils.get_openapi`.
+
+And that function `get_openapi()` receives as parameters:
+
+* `title`: The OpenAPI title, shown in the docs.
+* `version`: The version of your API, e.g. `2.5.0`.
+* `openapi_version`: The version of the OpenAPI specification used. By default, the latest: `3.1.0`.
+* `summary`: A short summary of the API.
+* `description`: The description of your API, this can include markdown and will be shown in the docs.
+* `routes`: A list of routes, these are each of the registered *path operations*. They are taken from `app.routes`.
+
+!!! info
+ The parameter `summary` is available in OpenAPI 3.1.0 and above, supported by FastAPI 0.99.0 and above.
+
+## Overriding the defaults
+
+Using the information above, you can use the same utility function to generate the OpenAPI schema and override each part that you need.
+
+For example, let's add ReDoc's OpenAPI extension to include a custom logo.
+
+### Normal **FastAPI**
+
+First, write all your **FastAPI** application as normally:
+
+```Python hl_lines="1 4 7-9"
+{!../../../docs_src/extending_openapi/tutorial001.py!}
+```
+
+### Generate the OpenAPI schema
+
+Then, use the same utility function to generate the OpenAPI schema, inside a `custom_openapi()` function:
+
+```Python hl_lines="2 15-21"
+{!../../../docs_src/extending_openapi/tutorial001.py!}
+```
+
+### Modify the OpenAPI schema
+
+Now you can add the ReDoc extension, adding a custom `x-logo` to the `info` "object" in the OpenAPI schema:
+
+```Python hl_lines="22-24"
+{!../../../docs_src/extending_openapi/tutorial001.py!}
+```
+
+### Cache the OpenAPI schema
+
+You can use the property `.openapi_schema` as a "cache", to store your generated schema.
+
+That way, your application won't have to generate the schema every time a user opens your API docs.
+
+It will be generated only once, and then the same cached schema will be used for the next requests.
+
+```Python hl_lines="13-14 25-26"
+{!../../../docs_src/extending_openapi/tutorial001.py!}
+```
+
+### Override the method
+
+Now you can replace the `.openapi()` method with your new function.
+
+```Python hl_lines="29"
+{!../../../docs_src/extending_openapi/tutorial001.py!}
+```
+
+### Check it
+
+Once you go to http://127.0.0.1:8000/redoc you will see that you are using your custom logo (in this example, **FastAPI**'s logo):
+
+
diff --git a/docs/en/docs/how-to/general.md b/docs/en/docs/how-to/general.md
new file mode 100644
index 000000000..04367c6b7
--- /dev/null
+++ b/docs/en/docs/how-to/general.md
@@ -0,0 +1,39 @@
+# General - How To - Recipes
+
+Here are several pointers to other places in the docs, for general or frequent questions.
+
+## Filter Data - Security
+
+To ensure that you don't return more data than you should, read the docs for [Tutorial - Response Model - Return Type](../tutorial/response-model.md){.internal-link target=_blank}.
+
+## Documentation Tags - OpenAPI
+
+To add tags to your *path operations*, and group them in the docs UI, read the docs for [Tutorial - Path Operation Configurations - Tags](../tutorial/path-operation-configuration.md#tags){.internal-link target=_blank}.
+
+## Documentation Summary and Description - OpenAPI
+
+To add a summary and description to your *path operations*, and show them in the docs UI, read the docs for [Tutorial - Path Operation Configurations - Summary and Description](../tutorial/path-operation-configuration.md#summary-and-description){.internal-link target=_blank}.
+
+## Documentation Response description - OpenAPI
+
+To define the description of the response, shown in the docs UI, read the docs for [Tutorial - Path Operation Configurations - Response description](../tutorial/path-operation-configuration.md#response-description){.internal-link target=_blank}.
+
+## Documentation Deprecate a *Path Operation* - OpenAPI
+
+To deprecate a *path operation*, and show it in the docs UI, read the docs for [Tutorial - Path Operation Configurations - Deprecation](../tutorial/path-operation-configuration.md#deprecate-a-path-operation){.internal-link target=_blank}.
+
+## Convert any Data to JSON-compatible
+
+To convert any data to JSON-compatible, read the docs for [Tutorial - JSON Compatible Encoder](../tutorial/encoder.md){.internal-link target=_blank}.
+
+## OpenAPI Metadata - Docs
+
+To add metadata to your OpenAPI schema, including a license, version, contact, etc, read the docs for [Tutorial - Metadata and Docs URLs](../tutorial/metadata.md){.internal-link target=_blank}.
+
+## OpenAPI Custom URL
+
+To customize the OpenAPI URL (or remove it), read the docs for [Tutorial - Metadata and Docs URLs](../tutorial/metadata.md#openapi-url){.internal-link target=_blank}.
+
+## OpenAPI Docs URLs
+
+To update the URLs used for the automatically generated docs user interfaces, read the docs for [Tutorial - Metadata and Docs URLs](../tutorial/metadata.md#docs-urls){.internal-link target=_blank}.
diff --git a/docs/en/docs/advanced/graphql.md b/docs/en/docs/how-to/graphql.md
similarity index 100%
rename from docs/en/docs/advanced/graphql.md
rename to docs/en/docs/how-to/graphql.md
diff --git a/docs/en/docs/how-to/index.md b/docs/en/docs/how-to/index.md
new file mode 100644
index 000000000..ec7fd38f8
--- /dev/null
+++ b/docs/en/docs/how-to/index.md
@@ -0,0 +1,11 @@
+# How To - Recipes
+
+Here you will see different recipes or "how to" guides for **several topics**.
+
+Most of these ideas would be more or less **independent**, and in most cases you should only need to study them if they apply directly to **your project**.
+
+If something seems interesting and useful to your project, go ahead and check it, but otherwise, you might probably just skip them.
+
+!!! tip
+
+ If you want to **learn FastAPI** in a structured way (recommended), go and read the [Tutorial - User Guide](../tutorial/index.md){.internal-link target=_blank} chapter by chapter instead.
diff --git a/docs/en/docs/advanced/nosql-databases.md b/docs/en/docs/how-to/nosql-databases-couchbase.md
similarity index 99%
rename from docs/en/docs/advanced/nosql-databases.md
rename to docs/en/docs/how-to/nosql-databases-couchbase.md
index 606db35c7..ae6ad604b 100644
--- a/docs/en/docs/advanced/nosql-databases.md
+++ b/docs/en/docs/how-to/nosql-databases-couchbase.md
@@ -1,4 +1,4 @@
-# NoSQL (Distributed / Big Data) Databases
+# NoSQL (Distributed / Big Data) Databases with Couchbase
!!! info
These docs are about to be updated. ๐
diff --git a/docs/en/docs/how-to/separate-openapi-schemas.md b/docs/en/docs/how-to/separate-openapi-schemas.md
new file mode 100644
index 000000000..10be1071a
--- /dev/null
+++ b/docs/en/docs/how-to/separate-openapi-schemas.md
@@ -0,0 +1,231 @@
+# Separate OpenAPI Schemas for Input and Output or Not
+
+When using **Pydantic v2**, the generated OpenAPI is a bit more exact and **correct** than before. ๐
+
+In fact, in some cases, it will even have **two JSON Schemas** in OpenAPI for the same Pydantic model, for input and output, depending on if they have **default values**.
+
+Let's see how that works and how to change it if you need to do that.
+
+## Pydantic Models for Input and Output
+
+Let's say you have a Pydantic model with default values, like this one:
+
+=== "Python 3.10+"
+
+ ```Python hl_lines="7"
+ {!> ../../../docs_src/separate_openapi_schemas/tutorial001_py310.py[ln:1-7]!}
+
+ # Code below omitted ๐
+ ```
+
+ 
+
+
+
+
+
contact fields| Parameter | Type | Description |
|---|---|---|
name | str | The identifying name of the contact person/organization. |
url | str | The URL pointing to the contact information. MUST be in the format of a URL. |
email | str | The email address of the contact person/organization. MUST be in the format of an email address. |
license_info fields| Parameter | Type | Description |
|---|---|---|
name | str | REQUIRED (if a license_info is set). The license name used for the API. |
identifier | str | An SPDX license expression for the API. The identifier field is mutually exclusive of the url field. Available since OpenAPI 3.1.0, FastAPI 0.99.0. |
url | str | A URL to the license used for the API. MUST be in the format of a URL. |
license_info fields| Parameter | Type | Description |
|---|---|---|
name | str | REQUIRED (if a license_info is set). The license name used for the API. |
identifier | str | An SPDX license expression for the API. The identifier field is mutually exclusive of the url field. Available since OpenAPI 3.1.0, FastAPI 0.99.0. |
url | str | A URL to the license used for the API. MUST be in the format of a URL. |
lt.
{!> ../../../docs_src/path_params_numeric_validations/tutorial006_an_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="12"
{!> ../../../docs_src/path_params_numeric_validations/tutorial006_an.py!}
```
-=== "Python 3.6+ non-Annotated"
+=== "Python 3.8+ non-Annotated"
!!! tip
Prefer to use the `Annotated` version if possible.
diff --git a/docs/en/docs/tutorial/path-params.md b/docs/en/docs/tutorial/path-params.md
index 6594a7a8b..847b56334 100644
--- a/docs/en/docs/tutorial/path-params.md
+++ b/docs/en/docs/tutorial/path-params.md
@@ -46,16 +46,18 @@ But if you go to the browser at ../../../docs_src/query_params_str_validations/tutorial001_py310.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="9"
{!> ../../../docs_src/query_params_str_validations/tutorial001.py!}
@@ -42,7 +42,7 @@ To achieve that, first import:
{!> ../../../docs_src/query_params_str_validations/tutorial002_an_py310.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
In versions of Python below Python 3.9 you import `Annotated` from `typing_extensions`.
@@ -73,7 +73,7 @@ We had this type annotation:
q: str | None = None
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python
q: Union[str, None] = None
@@ -87,7 +87,7 @@ What we will do is wrap that with `Annotated`, so it becomes:
q: Annotated[str | None] = None
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python
q: Annotated[Union[str, None]] = None
@@ -107,7 +107,7 @@ Now that we have this `Annotated` where we can put more metadata, add `Query` to
{!> ../../../docs_src/query_params_str_validations/tutorial002_an_py310.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="10"
{!> ../../../docs_src/query_params_str_validations/tutorial002_an.py!}
@@ -138,7 +138,7 @@ This is how you would use `Query()` as the default value of your function parame
{!> ../../../docs_src/query_params_str_validations/tutorial002_py310.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="9"
{!> ../../../docs_src/query_params_str_validations/tutorial002.py!}
@@ -251,7 +251,7 @@ You can also add a parameter `min_length`:
{!> ../../../docs_src/query_params_str_validations/tutorial003_an_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="11"
{!> ../../../docs_src/query_params_str_validations/tutorial003_an.py!}
@@ -266,7 +266,7 @@ You can also add a parameter `min_length`:
{!> ../../../docs_src/query_params_str_validations/tutorial003_py310.py!}
```
-=== "Python 3.6+ non-Annotated"
+=== "Python 3.8+ non-Annotated"
!!! tip
Prefer to use the `Annotated` version if possible.
@@ -291,7 +291,7 @@ You can define a ../../../docs_src/query_params_str_validations/tutorial004_an.py!}
@@ -306,7 +306,7 @@ You can define a ../../../docs_src/query_params_str_validations/tutorial005_an_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="8"
{!> ../../../docs_src/query_params_str_validations/tutorial005_an.py!}
```
-=== "Python 3.6+ non-Annotated"
+=== "Python 3.8+ non-Annotated"
!!! tip
Prefer to use the `Annotated` version if possible.
@@ -405,13 +405,13 @@ So, when you need to declare a value as required while using `Query`, you can si
{!> ../../../docs_src/query_params_str_validations/tutorial006_an_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="8"
{!> ../../../docs_src/query_params_str_validations/tutorial006_an.py!}
```
-=== "Python 3.6+ non-Annotated"
+=== "Python 3.8+ non-Annotated"
!!! tip
Prefer to use the `Annotated` version if possible.
@@ -435,13 +435,13 @@ There's an alternative way to explicitly declare that a value is required. You c
{!> ../../../docs_src/query_params_str_validations/tutorial006b_an_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="8"
{!> ../../../docs_src/query_params_str_validations/tutorial006b_an.py!}
```
-=== "Python 3.6+ non-Annotated"
+=== "Python 3.8+ non-Annotated"
!!! tip
Prefer to use the `Annotated` version if possible.
@@ -475,7 +475,7 @@ To do that, you can declare that `None` is a valid type but still use `...` as t
{!> ../../../docs_src/query_params_str_validations/tutorial006c_an_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="10"
{!> ../../../docs_src/query_params_str_validations/tutorial006c_an.py!}
@@ -490,7 +490,7 @@ To do that, you can declare that `None` is a valid type but still use `...` as t
{!> ../../../docs_src/query_params_str_validations/tutorial006c_py310.py!}
```
-=== "Python 3.6+ non-Annotated"
+=== "Python 3.8+ non-Annotated"
!!! tip
Prefer to use the `Annotated` version if possible.
@@ -502,33 +502,8 @@ To do that, you can declare that `None` is a valid type but still use `...` as t
!!! tip
Pydantic, which is what powers all the data validation and serialization in FastAPI, has a special behavior when you use `Optional` or `Union[Something, None]` without a default value, you can read more about it in the Pydantic docs about Required Optional fields.
-### Use Pydantic's `Required` instead of Ellipsis (`...`)
-
-If you feel uncomfortable using `...`, you can also import and use `Required` from Pydantic:
-
-=== "Python 3.9+"
-
- ```Python hl_lines="4 10"
- {!> ../../../docs_src/query_params_str_validations/tutorial006d_an_py39.py!}
- ```
-
-=== "Python 3.6+"
-
- ```Python hl_lines="2 9"
- {!> ../../../docs_src/query_params_str_validations/tutorial006d_an.py!}
- ```
-
-=== "Python 3.6+ non-Annotated"
-
- !!! tip
- Prefer to use the `Annotated` version if possible.
-
- ```Python hl_lines="2 8"
- {!> ../../../docs_src/query_params_str_validations/tutorial006d.py!}
- ```
-
!!! tip
- Remember that in most of the cases, when something is required, you can simply omit the default, so you normally don't have to use `...` nor `Required`.
+ Remember that in most of the cases, when something is required, you can simply omit the default, so you normally don't have to use `...`.
## Query parameter list / multiple values
@@ -548,7 +523,7 @@ For example, to declare a query parameter `q` that can appear multiple times in
{!> ../../../docs_src/query_params_str_validations/tutorial011_an_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="10"
{!> ../../../docs_src/query_params_str_validations/tutorial011_an.py!}
@@ -572,7 +547,7 @@ For example, to declare a query parameter `q` that can appear multiple times in
{!> ../../../docs_src/query_params_str_validations/tutorial011_py39.py!}
```
-=== "Python 3.6+ non-Annotated"
+=== "Python 3.8+ non-Annotated"
!!! tip
Prefer to use the `Annotated` version if possible.
@@ -617,7 +592,7 @@ And you can also define a default `list` of values if none are provided:
{!> ../../../docs_src/query_params_str_validations/tutorial012_an_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="10"
{!> ../../../docs_src/query_params_str_validations/tutorial012_an.py!}
@@ -632,7 +607,7 @@ And you can also define a default `list` of values if none are provided:
{!> ../../../docs_src/query_params_str_validations/tutorial012_py39.py!}
```
-=== "Python 3.6+ non-Annotated"
+=== "Python 3.8+ non-Annotated"
!!! tip
Prefer to use the `Annotated` version if possible.
@@ -668,13 +643,13 @@ You can also use `list` directly instead of `List[str]` (or `list[str]` in Pytho
{!> ../../../docs_src/query_params_str_validations/tutorial013_an_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="8"
{!> ../../../docs_src/query_params_str_validations/tutorial013_an.py!}
```
-=== "Python 3.6+ non-Annotated"
+=== "Python 3.8+ non-Annotated"
!!! tip
Prefer to use the `Annotated` version if possible.
@@ -713,7 +688,7 @@ You can add a `title`:
{!> ../../../docs_src/query_params_str_validations/tutorial007_an_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="11"
{!> ../../../docs_src/query_params_str_validations/tutorial007_an.py!}
@@ -728,7 +703,7 @@ You can add a `title`:
{!> ../../../docs_src/query_params_str_validations/tutorial007_py310.py!}
```
-=== "Python 3.6+ non-Annotated"
+=== "Python 3.8+ non-Annotated"
!!! tip
Prefer to use the `Annotated` version if possible.
@@ -751,7 +726,7 @@ And a `description`:
{!> ../../../docs_src/query_params_str_validations/tutorial008_an_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="15"
{!> ../../../docs_src/query_params_str_validations/tutorial008_an.py!}
@@ -766,7 +741,7 @@ And a `description`:
{!> ../../../docs_src/query_params_str_validations/tutorial008_py310.py!}
```
-=== "Python 3.6+ non-Annotated"
+=== "Python 3.8+ non-Annotated"
!!! tip
Prefer to use the `Annotated` version if possible.
@@ -805,7 +780,7 @@ Then you can declare an `alias`, and that alias is what will be used to find the
{!> ../../../docs_src/query_params_str_validations/tutorial009_an_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="10"
{!> ../../../docs_src/query_params_str_validations/tutorial009_an.py!}
@@ -820,7 +795,7 @@ Then you can declare an `alias`, and that alias is what will be used to find the
{!> ../../../docs_src/query_params_str_validations/tutorial009_py310.py!}
```
-=== "Python 3.6+ non-Annotated"
+=== "Python 3.8+ non-Annotated"
!!! tip
Prefer to use the `Annotated` version if possible.
@@ -849,7 +824,7 @@ Then pass the parameter `deprecated=True` to `Query`:
{!> ../../../docs_src/query_params_str_validations/tutorial010_an_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="20"
{!> ../../../docs_src/query_params_str_validations/tutorial010_an.py!}
@@ -864,7 +839,7 @@ Then pass the parameter `deprecated=True` to `Query`:
{!> ../../../docs_src/query_params_str_validations/tutorial010_py310.py!}
```
-=== "Python 3.6+ non-Annotated"
+=== "Python 3.8+ non-Annotated"
!!! tip
Prefer to use the `Annotated` version if possible.
@@ -893,7 +868,7 @@ To exclude a query parameter from the generated OpenAPI schema (and thus, from t
{!> ../../../docs_src/query_params_str_validations/tutorial014_an_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="11"
{!> ../../../docs_src/query_params_str_validations/tutorial014_an.py!}
@@ -908,7 +883,7 @@ To exclude a query parameter from the generated OpenAPI schema (and thus, from t
{!> ../../../docs_src/query_params_str_validations/tutorial014_py310.py!}
```
-=== "Python 3.6+ non-Annotated"
+=== "Python 3.8+ non-Annotated"
!!! tip
Prefer to use the `Annotated` version if possible.
@@ -932,7 +907,7 @@ Validations specific for strings:
* `min_length`
* `max_length`
-* `regex`
+* `pattern`
In these examples you saw how to declare validations for `str` values.
diff --git a/docs/en/docs/tutorial/query-params.md b/docs/en/docs/tutorial/query-params.md
index 0b74b10f8..bc3b11948 100644
--- a/docs/en/docs/tutorial/query-params.md
+++ b/docs/en/docs/tutorial/query-params.md
@@ -69,7 +69,7 @@ The same way, you can declare optional query parameters, by setting their defaul
{!> ../../../docs_src/query_params/tutorial002_py310.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="9"
{!> ../../../docs_src/query_params/tutorial002.py!}
@@ -90,7 +90,7 @@ You can also declare `bool` types, and they will be converted:
{!> ../../../docs_src/query_params/tutorial003_py310.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="9"
{!> ../../../docs_src/query_params/tutorial003.py!}
@@ -143,7 +143,7 @@ They will be detected by name:
{!> ../../../docs_src/query_params/tutorial004_py310.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="8 10"
{!> ../../../docs_src/query_params/tutorial004.py!}
@@ -173,16 +173,18 @@ http://127.0.0.1:8000/items/foo-item
```JSON
{
- "detail": [
- {
- "loc": [
- "query",
- "needy"
- ],
- "msg": "field required",
- "type": "value_error.missing"
- }
- ]
+ "detail": [
+ {
+ "type": "missing",
+ "loc": [
+ "query",
+ "needy"
+ ],
+ "msg": "Field required",
+ "input": null,
+ "url": "https://errors.pydantic.dev/2.1/v/missing"
+ }
+ ]
}
```
@@ -209,7 +211,7 @@ And of course, you can define some parameters as required, some as having a defa
{!> ../../../docs_src/query_params/tutorial006_py310.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="10"
{!> ../../../docs_src/query_params/tutorial006.py!}
diff --git a/docs/en/docs/tutorial/request-files.md b/docs/en/docs/tutorial/request-files.md
index 1fe1e7a33..c85a68ed6 100644
--- a/docs/en/docs/tutorial/request-files.md
+++ b/docs/en/docs/tutorial/request-files.md
@@ -19,13 +19,13 @@ Import `File` and `UploadFile` from `fastapi`:
{!> ../../../docs_src/request_files/tutorial001_an_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="1"
{!> ../../../docs_src/request_files/tutorial001_an.py!}
```
-=== "Python 3.6+ non-Annotated"
+=== "Python 3.8+ non-Annotated"
!!! tip
Prefer to use the `Annotated` version if possible.
@@ -44,13 +44,13 @@ Create file parameters the same way you would for `Body` or `Form`:
{!> ../../../docs_src/request_files/tutorial001_an_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="8"
{!> ../../../docs_src/request_files/tutorial001_an.py!}
```
-=== "Python 3.6+ non-Annotated"
+=== "Python 3.8+ non-Annotated"
!!! tip
Prefer to use the `Annotated` version if possible.
@@ -85,13 +85,13 @@ Define a file parameter with a type of `UploadFile`:
{!> ../../../docs_src/request_files/tutorial001_an_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="13"
{!> ../../../docs_src/request_files/tutorial001_an.py!}
```
-=== "Python 3.6+ non-Annotated"
+=== "Python 3.8+ non-Annotated"
!!! tip
Prefer to use the `Annotated` version if possible.
@@ -181,7 +181,7 @@ You can make a file optional by using standard type annotations and setting a de
{!> ../../../docs_src/request_files/tutorial001_02_an_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="10 18"
{!> ../../../docs_src/request_files/tutorial001_02_an.py!}
@@ -196,7 +196,7 @@ You can make a file optional by using standard type annotations and setting a de
{!> ../../../docs_src/request_files/tutorial001_02_py310.py!}
```
-=== "Python 3.6+ non-Annotated"
+=== "Python 3.8+ non-Annotated"
!!! tip
Prefer to use the `Annotated` version if possible.
@@ -215,13 +215,13 @@ You can also use `File()` with `UploadFile`, for example, to set additional meta
{!> ../../../docs_src/request_files/tutorial001_03_an_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="8 14"
{!> ../../../docs_src/request_files/tutorial001_03_an.py!}
```
-=== "Python 3.6+ non-Annotated"
+=== "Python 3.8+ non-Annotated"
!!! tip
Prefer to use the `Annotated` version if possible.
@@ -244,7 +244,7 @@ To use that, declare a list of `bytes` or `UploadFile`:
{!> ../../../docs_src/request_files/tutorial002_an_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="11 16"
{!> ../../../docs_src/request_files/tutorial002_an.py!}
@@ -259,7 +259,7 @@ To use that, declare a list of `bytes` or `UploadFile`:
{!> ../../../docs_src/request_files/tutorial002_py39.py!}
```
-=== "Python 3.6+ non-Annotated"
+=== "Python 3.8+ non-Annotated"
!!! tip
Prefer to use the `Annotated` version if possible.
@@ -285,7 +285,7 @@ And the same way as before, you can use `File()` to set additional parameters, e
{!> ../../../docs_src/request_files/tutorial003_an_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="12 19-21"
{!> ../../../docs_src/request_files/tutorial003_an.py!}
@@ -300,7 +300,7 @@ And the same way as before, you can use `File()` to set additional parameters, e
{!> ../../../docs_src/request_files/tutorial003_py39.py!}
```
-=== "Python 3.6+ non-Annotated"
+=== "Python 3.8+ non-Annotated"
!!! tip
Prefer to use the `Annotated` version if possible.
diff --git a/docs/en/docs/tutorial/request-forms-and-files.md b/docs/en/docs/tutorial/request-forms-and-files.md
index 1818946c4..a58291dc8 100644
--- a/docs/en/docs/tutorial/request-forms-and-files.md
+++ b/docs/en/docs/tutorial/request-forms-and-files.md
@@ -15,13 +15,13 @@ You can define files and form fields at the same time using `File` and `Form`.
{!> ../../../docs_src/request_forms_and_files/tutorial001_an_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="1"
{!> ../../../docs_src/request_forms_and_files/tutorial001_an.py!}
```
-=== "Python 3.6+ non-Annotated"
+=== "Python 3.8+ non-Annotated"
!!! tip
Prefer to use the `Annotated` version if possible.
@@ -40,13 +40,13 @@ Create file and form parameters the same way you would for `Body` or `Query`:
{!> ../../../docs_src/request_forms_and_files/tutorial001_an_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="9-11"
{!> ../../../docs_src/request_forms_and_files/tutorial001_an.py!}
```
-=== "Python 3.6+ non-Annotated"
+=== "Python 3.8+ non-Annotated"
!!! tip
Prefer to use the `Annotated` version if possible.
diff --git a/docs/en/docs/tutorial/request-forms.md b/docs/en/docs/tutorial/request-forms.md
index 5d441a614..0e8ac5f4f 100644
--- a/docs/en/docs/tutorial/request-forms.md
+++ b/docs/en/docs/tutorial/request-forms.md
@@ -17,13 +17,13 @@ Import `Form` from `fastapi`:
{!> ../../../docs_src/request_forms/tutorial001_an_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="1"
{!> ../../../docs_src/request_forms/tutorial001_an.py!}
```
-=== "Python 3.6+ non-Annotated"
+=== "Python 3.8+ non-Annotated"
!!! tip
Prefer to use the `Annotated` version if possible.
@@ -42,13 +42,13 @@ Create form parameters the same way you would for `Body` or `Query`:
{!> ../../../docs_src/request_forms/tutorial001_an_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="8"
{!> ../../../docs_src/request_forms/tutorial001_an.py!}
```
-=== "Python 3.6+ non-Annotated"
+=== "Python 3.8+ non-Annotated"
!!! tip
Prefer to use the `Annotated` version if possible.
diff --git a/docs/en/docs/tutorial/response-model.md b/docs/en/docs/tutorial/response-model.md
index 2181cfb5a..d6d3d61cb 100644
--- a/docs/en/docs/tutorial/response-model.md
+++ b/docs/en/docs/tutorial/response-model.md
@@ -16,7 +16,7 @@ You can use **type annotations** the same way you would for input data in functi
{!> ../../../docs_src/response_model/tutorial001_01_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="18 23"
{!> ../../../docs_src/response_model/tutorial001_01.py!}
@@ -65,7 +65,7 @@ You can use the `response_model` parameter in any of the *path operations*:
{!> ../../../docs_src/response_model/tutorial001_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="17 22 24-27"
{!> ../../../docs_src/response_model/tutorial001.py!}
@@ -101,7 +101,7 @@ Here we are declaring a `UserIn` model, it will contain a plaintext password:
{!> ../../../docs_src/response_model/tutorial002_py310.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="9 11"
{!> ../../../docs_src/response_model/tutorial002.py!}
@@ -121,7 +121,7 @@ And we are using this model to declare our input and the same model to declare o
{!> ../../../docs_src/response_model/tutorial002_py310.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="18"
{!> ../../../docs_src/response_model/tutorial002.py!}
@@ -146,7 +146,7 @@ We can instead create an input model with the plaintext password and an output m
{!> ../../../docs_src/response_model/tutorial003_py310.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="9 11 16"
{!> ../../../docs_src/response_model/tutorial003.py!}
@@ -160,7 +160,7 @@ Here, even though our *path operation function* is returning the same input user
{!> ../../../docs_src/response_model/tutorial003_py310.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="24"
{!> ../../../docs_src/response_model/tutorial003.py!}
@@ -174,7 +174,7 @@ Here, even though our *path operation function* is returning the same input user
{!> ../../../docs_src/response_model/tutorial003_py310.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="22"
{!> ../../../docs_src/response_model/tutorial003.py!}
@@ -208,7 +208,7 @@ And in those cases, we can use classes and inheritance to take advantage of func
{!> ../../../docs_src/response_model/tutorial003_01_py310.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="9-13 15-16 20"
{!> ../../../docs_src/response_model/tutorial003_01.py!}
@@ -284,7 +284,7 @@ The same would happen if you had something like a .
- You can set `"json_schema_extra"` with a `dict` containing any additonal data you would like to show up in the generated JSON Schema, including `examples`.
+ You can set `"json_schema_extra"` with a `dict` containing any additional data you would like to show up in the generated JSON Schema, including `examples`.
=== "Pydantic v1"
In Pydantic version 1, you would use an internal class `Config` and `schema_extra`, as described in Pydantic's docs: Schema customization.
- You can set `schema_extra` with a `dict` containing any additonal data you would like to show up in the generated JSON Schema, including `examples`.
+ You can set `schema_extra` with a `dict` containing any additional data you would like to show up in the generated JSON Schema, including `examples`.
!!! tip
You could use the same technique to extend the JSON Schema and add your own custom extra info.
@@ -68,13 +68,13 @@ When using `Field()` with Pydantic models, you can also declare additional `exam
{!> ../../../docs_src/schema_extra_example/tutorial002_py310.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="4 10-13"
{!> ../../../docs_src/schema_extra_example/tutorial002.py!}
```
-## `examples` in OpenAPI
+## `examples` in JSON Schema - OpenAPI
When using any of:
@@ -86,7 +86,7 @@ When using any of:
* `Form()`
* `File()`
-you can also declare a group of `examples` with additional information that will be added to **OpenAPI**.
+you can also declare a group of `examples` with additional information that will be added to their **JSON Schemas** inside of **OpenAPI**.
### `Body` with `examples`
@@ -104,7 +104,7 @@ Here we pass `examples` containing one example of the data expected in `Body()`:
{!> ../../../docs_src/schema_extra_example/tutorial003_an_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="23-30"
{!> ../../../docs_src/schema_extra_example/tutorial003_an.py!}
@@ -119,7 +119,7 @@ Here we pass `examples` containing one example of the data expected in `Body()`:
{!> ../../../docs_src/schema_extra_example/tutorial003_py310.py!}
```
-=== "Python 3.6+ non-Annotated"
+=== "Python 3.8+ non-Annotated"
!!! tip
Prefer to use the `Annotated` version if possible.
@@ -150,7 +150,7 @@ You can of course also pass multiple `examples`:
{!> ../../../docs_src/schema_extra_example/tutorial004_an_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="24-39"
{!> ../../../docs_src/schema_extra_example/tutorial004_an.py!}
@@ -165,7 +165,7 @@ You can of course also pass multiple `examples`:
{!> ../../../docs_src/schema_extra_example/tutorial004_py310.py!}
```
-=== "Python 3.6+ non-Annotated"
+=== "Python 3.8+ non-Annotated"
!!! tip
Prefer to use the `Annotated` version if possible.
@@ -174,9 +174,84 @@ You can of course also pass multiple `examples`:
{!> ../../../docs_src/schema_extra_example/tutorial004.py!}
```
-### Examples in the docs UI
+When you do this, the examples will be part of the internal **JSON Schema** for that body data.
-With `examples` added to `Body()` the `/docs` would look like:
+Nevertheless, at the time of writing this, Swagger UI, the tool in charge of showing the docs UI, doesn't support showing multiple examples for the data in **JSON Schema**. But read below for a workaround.
+
+### OpenAPI-specific `examples`
+
+Since before **JSON Schema** supported `examples` OpenAPI had support for a different field also called `examples`.
+
+This **OpenAPI-specific** `examples` goes in another section in the OpenAPI specification. It goes in the **details for each *path operation***, not inside each JSON Schema.
+
+And Swagger UI has supported this particular `examples` field for a while. So, you can use it to **show** different **examples in the docs UI**.
+
+The shape of this OpenAPI-specific field `examples` is a `dict` with **multiple examples** (instead of a `list`), each with extra information that will be added to **OpenAPI** too.
+
+This doesn't go inside of each JSON Schema contained in OpenAPI, this goes outside, in the *path operation* directly.
+
+### Using the `openapi_examples` Parameter
+
+You can declare the OpenAPI-specific `examples` in FastAPI with the parameter `openapi_examples` for:
+
+* `Path()`
+* `Query()`
+* `Header()`
+* `Cookie()`
+* `Body()`
+* `Form()`
+* `File()`
+
+The keys of the `dict` identify each example, and each value is another `dict`.
+
+Each specific example `dict` in the `examples` can contain:
+
+* `summary`: Short description for the example.
+* `description`: A long description that can contain Markdown text.
+* `value`: This is the actual example shown, e.g. a `dict`.
+* `externalValue`: alternative to `value`, a URL pointing to the example. Although this might not be supported by as many tools as `value`.
+
+You can use it like this:
+
+=== "Python 3.10+"
+
+ ```Python hl_lines="23-49"
+ {!> ../../../docs_src/schema_extra_example/tutorial005_an_py310.py!}
+ ```
+
+=== "Python 3.9+"
+
+ ```Python hl_lines="23-49"
+ {!> ../../../docs_src/schema_extra_example/tutorial005_an_py39.py!}
+ ```
+
+=== "Python 3.8+"
+
+ ```Python hl_lines="24-50"
+ {!> ../../../docs_src/schema_extra_example/tutorial005_an.py!}
+ ```
+
+=== "Python 3.10+ non-Annotated"
+
+ !!! tip
+ Prefer to use the `Annotated` version if possible.
+
+ ```Python hl_lines="19-45"
+ {!> ../../../docs_src/schema_extra_example/tutorial005_py310.py!}
+ ```
+
+=== "Python 3.8+ non-Annotated"
+
+ !!! tip
+ Prefer to use the `Annotated` version if possible.
+
+ ```Python hl_lines="21-47"
+ {!> ../../../docs_src/schema_extra_example/tutorial005.py!}
+ ```
+
+### OpenAPI Examples in the Docs UI
+
+With `openapi_examples` added to `Body()` the `/docs` would look like:
@@ -210,20 +285,8 @@ OpenAPI also added `example` and `examples` fields to other parts of the specifi
* `File()`
* `Form()`
-### OpenAPI's `examples` field
-
-The shape of this field `examples` from OpenAPI is a `dict` with **multiple examples**, each with extra information that will be added to **OpenAPI** too.
-
-The keys of the `dict` identify each example, and each value is another `dict`.
-
-Each specific example `dict` in the `examples` can contain:
-
-* `summary`: Short description for the example.
-* `description`: A long description that can contain Markdown text.
-* `value`: This is the actual example shown, e.g. a `dict`.
-* `externalValue`: alternative to `value`, a URL pointing to the example. Although this might not be supported by as many tools as `value`.
-
-This applies to those other parts of the OpenAPI specification apart from JSON Schema.
+!!! info
+ This old OpenAPI-specific `examples` parameter is now `openapi_examples` since FastAPI `0.103.0`.
### JSON Schema's `examples` field
@@ -250,6 +313,12 @@ In versions of FastAPI before 0.99.0 (0.99.0 and above use the newer OpenAPI 3.1
But now that FastAPI 0.99.0 and above uses OpenAPI 3.1.0, that uses JSON Schema 2020-12, and Swagger UI 5.0.0 and above, everything is more consistent and the examples are included in JSON Schema.
+### Swagger UI and OpenAPI-specific `examples`
+
+Now, as Swagger UI didn't support multiple JSON Schema examples (as of 2023-08-26), users didn't have a way to show multiple examples in the docs.
+
+To solve that, FastAPI `0.103.0` **added support** for declaring the same old **OpenAPI-specific** `examples` field with the new parameter `openapi_examples`. ๐ค
+
### Summary
I used to say I didn't like history that much... and look at me now giving "tech history" lessons. ๐
diff --git a/docs/en/docs/tutorial/security/first-steps.md b/docs/en/docs/tutorial/security/first-steps.md
index 5765cf2d6..2f39f1ec2 100644
--- a/docs/en/docs/tutorial/security/first-steps.md
+++ b/docs/en/docs/tutorial/security/first-steps.md
@@ -26,13 +26,13 @@ Copy the example in a file `main.py`:
{!> ../../../docs_src/security/tutorial001_an_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python
{!> ../../../docs_src/security/tutorial001_an.py!}
```
-=== "Python 3.6+ non-Annotated"
+=== "Python 3.8+ non-Annotated"
!!! tip
Prefer to use the `Annotated` version if possible.
@@ -140,13 +140,13 @@ When we create an instance of the `OAuth2PasswordBearer` class we pass in the `t
{!> ../../../docs_src/security/tutorial001_an_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="7"
{!> ../../../docs_src/security/tutorial001_an.py!}
```
-=== "Python 3.6+ non-Annotated"
+=== "Python 3.8+ non-Annotated"
!!! tip
Prefer to use the `Annotated` version if possible.
@@ -191,13 +191,13 @@ Now you can pass that `oauth2_scheme` in a dependency with `Depends`.
{!> ../../../docs_src/security/tutorial001_an_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="11"
{!> ../../../docs_src/security/tutorial001_an.py!}
```
-=== "Python 3.6+ non-Annotated"
+=== "Python 3.8+ non-Annotated"
!!! tip
Prefer to use the `Annotated` version if possible.
diff --git a/docs/en/docs/tutorial/security/get-current-user.md b/docs/en/docs/tutorial/security/get-current-user.md
index 1a8c5d9a8..e99a800c6 100644
--- a/docs/en/docs/tutorial/security/get-current-user.md
+++ b/docs/en/docs/tutorial/security/get-current-user.md
@@ -8,13 +8,13 @@ In the previous chapter the security system (which is based on the dependency in
{!> ../../../docs_src/security/tutorial001_an_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="11"
{!> ../../../docs_src/security/tutorial001_an.py!}
```
-=== "Python 3.6+ non-Annotated"
+=== "Python 3.8+ non-Annotated"
!!! tip
Prefer to use the `Annotated` version if possible.
@@ -45,7 +45,7 @@ The same way we use Pydantic to declare bodies, we can use it anywhere else:
{!> ../../../docs_src/security/tutorial002_an_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="5 13-17"
{!> ../../../docs_src/security/tutorial002_an.py!}
@@ -60,7 +60,7 @@ The same way we use Pydantic to declare bodies, we can use it anywhere else:
{!> ../../../docs_src/security/tutorial002_py310.py!}
```
-=== "Python 3.6+ non-Annotated"
+=== "Python 3.8+ non-Annotated"
!!! tip
Prefer to use the `Annotated` version if possible.
@@ -91,7 +91,7 @@ The same as we were doing before in the *path operation* directly, our new depen
{!> ../../../docs_src/security/tutorial002_an_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="26"
{!> ../../../docs_src/security/tutorial002_an.py!}
@@ -106,7 +106,7 @@ The same as we were doing before in the *path operation* directly, our new depen
{!> ../../../docs_src/security/tutorial002_py310.py!}
```
-=== "Python 3.6+ non-Annotated"
+=== "Python 3.8+ non-Annotated"
!!! tip
Prefer to use the `Annotated` version if possible.
@@ -131,7 +131,7 @@ The same as we were doing before in the *path operation* directly, our new depen
{!> ../../../docs_src/security/tutorial002_an_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="20-23 27-28"
{!> ../../../docs_src/security/tutorial002_an.py!}
@@ -146,7 +146,7 @@ The same as we were doing before in the *path operation* directly, our new depen
{!> ../../../docs_src/security/tutorial002_py310.py!}
```
-=== "Python 3.6+ non-Annotated"
+=== "Python 3.8+ non-Annotated"
!!! tip
Prefer to use the `Annotated` version if possible.
@@ -171,7 +171,7 @@ So now we can use the same `Depends` with our `get_current_user` in the *path op
{!> ../../../docs_src/security/tutorial002_an_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="32"
{!> ../../../docs_src/security/tutorial002_an.py!}
@@ -186,7 +186,7 @@ So now we can use the same `Depends` with our `get_current_user` in the *path op
{!> ../../../docs_src/security/tutorial002_py310.py!}
```
-=== "Python 3.6+ non-Annotated"
+=== "Python 3.8+ non-Annotated"
!!! tip
Prefer to use the `Annotated` version if possible.
@@ -253,7 +253,7 @@ And all these thousands of *path operations* can be as small as 3 lines:
{!> ../../../docs_src/security/tutorial002_an_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="31-33"
{!> ../../../docs_src/security/tutorial002_an.py!}
@@ -268,7 +268,7 @@ And all these thousands of *path operations* can be as small as 3 lines:
{!> ../../../docs_src/security/tutorial002_py310.py!}
```
-=== "Python 3.6+ non-Annotated"
+=== "Python 3.8+ non-Annotated"
!!! tip
Prefer to use the `Annotated` version if possible.
diff --git a/docs/en/docs/tutorial/security/oauth2-jwt.md b/docs/en/docs/tutorial/security/oauth2-jwt.md
index deb722b96..0a347fed3 100644
--- a/docs/en/docs/tutorial/security/oauth2-jwt.md
+++ b/docs/en/docs/tutorial/security/oauth2-jwt.md
@@ -121,7 +121,7 @@ And another one to authenticate and return a user.
{!> ../../../docs_src/security/tutorial004_an_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="7 49 56-57 60-61 70-76"
{!> ../../../docs_src/security/tutorial004_an.py!}
@@ -136,7 +136,7 @@ And another one to authenticate and return a user.
{!> ../../../docs_src/security/tutorial004_py310.py!}
```
-=== "Python 3.6+ non-Annotated"
+=== "Python 3.8+ non-Annotated"
!!! tip
Prefer to use the `Annotated` version if possible.
@@ -188,7 +188,7 @@ Create a utility function to generate a new access token.
{!> ../../../docs_src/security/tutorial004_an_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="6 13-15 29-31 79-87"
{!> ../../../docs_src/security/tutorial004_an.py!}
@@ -203,7 +203,7 @@ Create a utility function to generate a new access token.
{!> ../../../docs_src/security/tutorial004_py310.py!}
```
-=== "Python 3.6+ non-Annotated"
+=== "Python 3.8+ non-Annotated"
!!! tip
Prefer to use the `Annotated` version if possible.
@@ -232,7 +232,7 @@ If the token is invalid, return an HTTP error right away.
{!> ../../../docs_src/security/tutorial004_an_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="90-107"
{!> ../../../docs_src/security/tutorial004_an.py!}
@@ -247,7 +247,7 @@ If the token is invalid, return an HTTP error right away.
{!> ../../../docs_src/security/tutorial004_py310.py!}
```
-=== "Python 3.6+ non-Annotated"
+=== "Python 3.8+ non-Annotated"
!!! tip
Prefer to use the `Annotated` version if possible.
@@ -274,7 +274,7 @@ Create a real JWT access token and return it
{!> ../../../docs_src/security/tutorial004_an_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="118-133"
{!> ../../../docs_src/security/tutorial004_an.py!}
@@ -289,7 +289,7 @@ Create a real JWT access token and return it
{!> ../../../docs_src/security/tutorial004_py310.py!}
```
-=== "Python 3.6+ non-Annotated"
+=== "Python 3.8+ non-Annotated"
!!! tip
Prefer to use the `Annotated` version if possible.
diff --git a/docs/en/docs/tutorial/security/simple-oauth2.md b/docs/en/docs/tutorial/security/simple-oauth2.md
index abcf6b667..88edc9eab 100644
--- a/docs/en/docs/tutorial/security/simple-oauth2.md
+++ b/docs/en/docs/tutorial/security/simple-oauth2.md
@@ -61,7 +61,7 @@ First, import `OAuth2PasswordRequestForm`, and use it as a dependency with `Depe
{!> ../../../docs_src/security/tutorial003_an_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="4 79"
{!> ../../../docs_src/security/tutorial003_an.py!}
@@ -76,7 +76,7 @@ First, import `OAuth2PasswordRequestForm`, and use it as a dependency with `Depe
{!> ../../../docs_src/security/tutorial003_py310.py!}
```
-=== "Python 3.6+ non-Annotated"
+=== "Python 3.8+ non-Annotated"
!!! tip
Prefer to use the `Annotated` version if possible.
@@ -134,7 +134,7 @@ For the error, we use the exception `HTTPException`:
{!> ../../../docs_src/security/tutorial003_an_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="3 80-82"
{!> ../../../docs_src/security/tutorial003_an.py!}
@@ -149,7 +149,7 @@ For the error, we use the exception `HTTPException`:
{!> ../../../docs_src/security/tutorial003_py310.py!}
```
-=== "Python 3.6+ non-Annotated"
+=== "Python 3.8+ non-Annotated"
!!! tip
Prefer to use the `Annotated` version if possible.
@@ -194,7 +194,7 @@ So, the thief won't be able to try to use those same passwords in another system
{!> ../../../docs_src/security/tutorial003_an_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="83-86"
{!> ../../../docs_src/security/tutorial003_an.py!}
@@ -209,7 +209,7 @@ So, the thief won't be able to try to use those same passwords in another system
{!> ../../../docs_src/security/tutorial003_py310.py!}
```
-=== "Python 3.6+ non-Annotated"
+=== "Python 3.8+ non-Annotated"
!!! tip
Prefer to use the `Annotated` version if possible.
@@ -264,7 +264,7 @@ For this simple example, we are going to just be completely insecure and return
{!> ../../../docs_src/security/tutorial003_an_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="88"
{!> ../../../docs_src/security/tutorial003_an.py!}
@@ -279,7 +279,7 @@ For this simple example, we are going to just be completely insecure and return
{!> ../../../docs_src/security/tutorial003_py310.py!}
```
-=== "Python 3.6+ non-Annotated"
+=== "Python 3.8+ non-Annotated"
!!! tip
Prefer to use the `Annotated` version if possible.
@@ -321,7 +321,7 @@ So, in our endpoint, we will only get a user if the user exists, was correctly a
{!> ../../../docs_src/security/tutorial003_an_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="59-67 70-75 95"
{!> ../../../docs_src/security/tutorial003_an.py!}
@@ -336,7 +336,7 @@ So, in our endpoint, we will only get a user if the user exists, was correctly a
{!> ../../../docs_src/security/tutorial003_py310.py!}
```
-=== "Python 3.6+ non-Annotated"
+=== "Python 3.8+ non-Annotated"
!!! tip
Prefer to use the `Annotated` version if possible.
diff --git a/docs/en/docs/tutorial/sql-databases.md b/docs/en/docs/tutorial/sql-databases.md
index 6e0e5dc06..010244bbf 100644
--- a/docs/en/docs/tutorial/sql-databases.md
+++ b/docs/en/docs/tutorial/sql-databases.md
@@ -281,7 +281,7 @@ But for security, the `password` won't be in other Pydantic *models*, for exampl
{!> ../../../docs_src/sql_databases/sql_app_py39/schemas.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="3 6-8 11-12 23-24 27-28"
{!> ../../../docs_src/sql_databases/sql_app/schemas.py!}
@@ -325,7 +325,7 @@ Not only the IDs of those items, but all the data that we defined in the Pydanti
{!> ../../../docs_src/sql_databases/sql_app_py39/schemas.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="15-17 31-34"
{!> ../../../docs_src/sql_databases/sql_app/schemas.py!}
@@ -354,7 +354,7 @@ In the `Config` class, set the attribute `orm_mode = True`.
{!> ../../../docs_src/sql_databases/sql_app_py39/schemas.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="15 19-20 31 36-37"
{!> ../../../docs_src/sql_databases/sql_app/schemas.py!}
@@ -494,7 +494,7 @@ In a very simplistic way create the database tables:
{!> ../../../docs_src/sql_databases/sql_app_py39/main.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="9"
{!> ../../../docs_src/sql_databases/sql_app/main.py!}
@@ -528,7 +528,7 @@ Our dependency will create a new SQLAlchemy `SessionLocal` that will be used in
{!> ../../../docs_src/sql_databases/sql_app_py39/main.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="15-20"
{!> ../../../docs_src/sql_databases/sql_app/main.py!}
@@ -553,7 +553,7 @@ This will then give us better editor support inside the *path operation function
{!> ../../../docs_src/sql_databases/sql_app_py39/main.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="24 32 38 47 53"
{!> ../../../docs_src/sql_databases/sql_app/main.py!}
@@ -574,7 +574,7 @@ Now, finally, here's the standard **FastAPI** *path operations* code.
{!> ../../../docs_src/sql_databases/sql_app_py39/main.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="23-28 31-34 37-42 45-49 52-55"
{!> ../../../docs_src/sql_databases/sql_app/main.py!}
@@ -673,7 +673,7 @@ For example, in a background task worker with ../../../docs_src/sql_databases/sql_app_py39/schemas.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python
{!> ../../../docs_src/sql_databases/sql_app/schemas.py!}
@@ -693,7 +693,7 @@ For example, in a background task worker with ../../../docs_src/sql_databases/sql_app_py39/main.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python
{!> ../../../docs_src/sql_databases/sql_app/main.py!}
@@ -752,7 +752,7 @@ The middleware we'll add (just a function) will create a new SQLAlchemy `Session
{!> ../../../docs_src/sql_databases/sql_app_py39/alt_main.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="14-22"
{!> ../../../docs_src/sql_databases/sql_app/alt_main.py!}
diff --git a/docs/en/docs/tutorial/testing.md b/docs/en/docs/tutorial/testing.md
index ec133a4d0..3f8dd69a1 100644
--- a/docs/en/docs/tutorial/testing.md
+++ b/docs/en/docs/tutorial/testing.md
@@ -122,7 +122,7 @@ Both *path operations* require an `X-Token` header.
{!> ../../../docs_src/app_testing/app_b_an_py39/main.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python
{!> ../../../docs_src/app_testing/app_b_an/main.py!}
@@ -137,7 +137,7 @@ Both *path operations* require an `X-Token` header.
{!> ../../../docs_src/app_testing/app_b_py310/main.py!}
```
-=== "Python 3.6+ non-Annotated"
+=== "Python 3.8+ non-Annotated"
!!! tip
Prefer to use the `Annotated` version if possible.
diff --git a/docs/en/mkdocs.yml b/docs/en/mkdocs.yml
index a18613185..a64eff269 100644
--- a/docs/en/mkdocs.yml
+++ b/docs/en/mkdocs.yml
@@ -30,6 +30,7 @@ theme:
- content.code.annotate
- content.code.copy
- content.code.select
+ - navigation.tabs
icon:
repo: fontawesome/brands/github-alt
logo: img/icon-white.svg
@@ -42,134 +43,184 @@ plugins:
search: null
markdownextradata:
data: ../en/data
+ redirects:
+ redirect_maps:
+ deployment/deta.md: deployment/cloud.md
+ advanced/sql-databases-peewee.md: how-to/sql-databases-peewee.md
+ advanced/async-sql-databases.md: how-to/async-sql-encode-databases.md
+ advanced/nosql-databases.md: how-to/nosql-databases-couchbase.md
+ advanced/graphql.md: how-to/graphql.md
+ advanced/custom-request-and-route.md: how-to/custom-request-and-route.md
+ advanced/conditional-openapi.md: how-to/conditional-openapi.md
+ advanced/extending-openapi.md: how-to/extending-openapi.md
+ mkdocstrings:
+ handlers:
+ python:
+ options:
+ extensions:
+ - griffe_typingdoc
+ show_root_heading: true
+ show_if_no_docstring: true
+ preload_modules: [httpx, starlette]
+ inherited_members: true
+ members_order: source
+ separate_signature: true
+ unwrap_annotated: true
+ filters: ["!^_"]
+ merge_init_into_class: true
+ docstring_section_style: spacy
+ signature_crossrefs: true
+ show_symbol_type_heading: true
+ show_symbol_type_toc: true
nav:
- FastAPI: index.md
-- Languages:
- - en: /
- - de: /de/
- - em: /em/
- - es: /es/
- - fa: /fa/
- - fr: /fr/
- - he: /he/
- - id: /id/
- - ja: /ja/
- - ko: /ko/
- - pl: /pl/
- - pt: /pt/
- - ru: /ru/
- - tr: /tr/
- - uk: /uk/
- - vi: /vi/
- - zh: /zh/
- features.md
+- Learn:
+ - learn/index.md
+ - python-types.md
+ - async.md
+ - Tutorial - User Guide:
+ - tutorial/index.md
+ - tutorial/first-steps.md
+ - tutorial/path-params.md
+ - tutorial/query-params.md
+ - tutorial/body.md
+ - tutorial/query-params-str-validations.md
+ - tutorial/path-params-numeric-validations.md
+ - tutorial/body-multiple-params.md
+ - tutorial/body-fields.md
+ - tutorial/body-nested-models.md
+ - tutorial/schema-extra-example.md
+ - tutorial/extra-data-types.md
+ - tutorial/cookie-params.md
+ - tutorial/header-params.md
+ - tutorial/response-model.md
+ - tutorial/extra-models.md
+ - tutorial/response-status-code.md
+ - tutorial/request-forms.md
+ - tutorial/request-files.md
+ - tutorial/request-forms-and-files.md
+ - tutorial/handling-errors.md
+ - tutorial/path-operation-configuration.md
+ - tutorial/encoder.md
+ - tutorial/body-updates.md
+ - Dependencies:
+ - tutorial/dependencies/index.md
+ - tutorial/dependencies/classes-as-dependencies.md
+ - tutorial/dependencies/sub-dependencies.md
+ - tutorial/dependencies/dependencies-in-path-operation-decorators.md
+ - tutorial/dependencies/global-dependencies.md
+ - tutorial/dependencies/dependencies-with-yield.md
+ - Security:
+ - tutorial/security/index.md
+ - tutorial/security/first-steps.md
+ - tutorial/security/get-current-user.md
+ - tutorial/security/simple-oauth2.md
+ - tutorial/security/oauth2-jwt.md
+ - tutorial/middleware.md
+ - tutorial/cors.md
+ - tutorial/sql-databases.md
+ - tutorial/bigger-applications.md
+ - tutorial/background-tasks.md
+ - tutorial/metadata.md
+ - tutorial/static-files.md
+ - tutorial/testing.md
+ - tutorial/debugging.md
+ - Advanced User Guide:
+ - advanced/index.md
+ - advanced/path-operation-advanced-configuration.md
+ - advanced/additional-status-codes.md
+ - advanced/response-directly.md
+ - advanced/custom-response.md
+ - advanced/additional-responses.md
+ - advanced/response-cookies.md
+ - advanced/response-headers.md
+ - advanced/response-change-status-code.md
+ - advanced/advanced-dependencies.md
+ - Advanced Security:
+ - advanced/security/index.md
+ - advanced/security/oauth2-scopes.md
+ - advanced/security/http-basic-auth.md
+ - advanced/using-request-directly.md
+ - advanced/dataclasses.md
+ - advanced/middleware.md
+ - advanced/sub-applications.md
+ - advanced/behind-a-proxy.md
+ - advanced/templates.md
+ - advanced/websockets.md
+ - advanced/events.md
+ - advanced/testing-websockets.md
+ - advanced/testing-events.md
+ - advanced/testing-dependencies.md
+ - advanced/testing-database.md
+ - advanced/async-tests.md
+ - advanced/settings.md
+ - advanced/openapi-callbacks.md
+ - advanced/openapi-webhooks.md
+ - advanced/wsgi.md
+ - advanced/generate-clients.md
+ - Deployment:
+ - deployment/index.md
+ - deployment/versions.md
+ - deployment/https.md
+ - deployment/manually.md
+ - deployment/concepts.md
+ - deployment/cloud.md
+ - deployment/server-workers.md
+ - deployment/docker.md
+ - How To - Recipes:
+ - how-to/index.md
+ - how-to/general.md
+ - how-to/sql-databases-peewee.md
+ - how-to/async-sql-encode-databases.md
+ - how-to/nosql-databases-couchbase.md
+ - how-to/graphql.md
+ - how-to/custom-request-and-route.md
+ - how-to/conditional-openapi.md
+ - how-to/extending-openapi.md
+ - how-to/separate-openapi-schemas.md
+ - how-to/custom-docs-ui-assets.md
+ - how-to/configure-swagger-ui.md
+- Reference (Code API):
+ - reference/index.md
+ - reference/fastapi.md
+ - reference/parameters.md
+ - reference/status.md
+ - reference/uploadfile.md
+ - reference/exceptions.md
+ - reference/dependencies.md
+ - reference/apirouter.md
+ - reference/background.md
+ - reference/request.md
+ - reference/websockets.md
+ - reference/httpconnection.md
+ - reference/response.md
+ - reference/responses.md
+ - reference/middleware.md
+ - OpenAPI:
+ - reference/openapi/index.md
+ - reference/openapi/docs.md
+ - reference/openapi/models.md
+ - reference/security/index.md
+ - reference/encoders.md
+ - reference/staticfiles.md
+ - reference/templating.md
+ - reference/testclient.md
- fastapi-people.md
-- python-types.md
-- Tutorial - User Guide:
- - tutorial/index.md
- - tutorial/first-steps.md
- - tutorial/path-params.md
- - tutorial/query-params.md
- - tutorial/body.md
- - tutorial/query-params-str-validations.md
- - tutorial/path-params-numeric-validations.md
- - tutorial/body-multiple-params.md
- - tutorial/body-fields.md
- - tutorial/body-nested-models.md
- - tutorial/schema-extra-example.md
- - tutorial/extra-data-types.md
- - tutorial/cookie-params.md
- - tutorial/header-params.md
- - tutorial/response-model.md
- - tutorial/extra-models.md
- - tutorial/response-status-code.md
- - tutorial/request-forms.md
- - tutorial/request-files.md
- - tutorial/request-forms-and-files.md
- - tutorial/handling-errors.md
- - tutorial/path-operation-configuration.md
- - tutorial/encoder.md
- - tutorial/body-updates.md
- - Dependencies:
- - tutorial/dependencies/index.md
- - tutorial/dependencies/classes-as-dependencies.md
- - tutorial/dependencies/sub-dependencies.md
- - tutorial/dependencies/dependencies-in-path-operation-decorators.md
- - tutorial/dependencies/global-dependencies.md
- - tutorial/dependencies/dependencies-with-yield.md
- - Security:
- - tutorial/security/index.md
- - tutorial/security/first-steps.md
- - tutorial/security/get-current-user.md
- - tutorial/security/simple-oauth2.md
- - tutorial/security/oauth2-jwt.md
- - tutorial/middleware.md
- - tutorial/cors.md
- - tutorial/sql-databases.md
- - tutorial/bigger-applications.md
- - tutorial/background-tasks.md
- - tutorial/metadata.md
- - tutorial/static-files.md
- - tutorial/testing.md
- - tutorial/debugging.md
-- Advanced User Guide:
- - advanced/index.md
- - advanced/path-operation-advanced-configuration.md
- - advanced/additional-status-codes.md
- - advanced/response-directly.md
- - advanced/custom-response.md
- - advanced/additional-responses.md
- - advanced/response-cookies.md
- - advanced/response-headers.md
- - advanced/response-change-status-code.md
- - advanced/advanced-dependencies.md
- - Advanced Security:
- - advanced/security/index.md
- - advanced/security/oauth2-scopes.md
- - advanced/security/http-basic-auth.md
- - advanced/using-request-directly.md
- - advanced/dataclasses.md
- - advanced/middleware.md
- - advanced/sql-databases-peewee.md
- - advanced/async-sql-databases.md
- - advanced/nosql-databases.md
- - advanced/sub-applications.md
- - advanced/behind-a-proxy.md
- - advanced/templates.md
- - advanced/graphql.md
- - advanced/websockets.md
- - advanced/events.md
- - advanced/custom-request-and-route.md
- - advanced/testing-websockets.md
- - advanced/testing-events.md
- - advanced/testing-dependencies.md
- - advanced/testing-database.md
- - advanced/async-tests.md
- - advanced/settings.md
- - advanced/conditional-openapi.md
- - advanced/extending-openapi.md
- - advanced/openapi-callbacks.md
- - advanced/openapi-webhooks.md
- - advanced/wsgi.md
- - advanced/generate-clients.md
-- async.md
-- Deployment:
- - deployment/index.md
- - deployment/versions.md
- - deployment/https.md
- - deployment/manually.md
- - deployment/concepts.md
- - deployment/deta.md
- - deployment/server-workers.md
- - deployment/docker.md
-- project-generation.md
-- alternatives.md
-- history-design-future.md
-- external-links.md
-- benchmarks.md
-- help-fastapi.md
-- newsletter.md
-- contributing.md
+- Resources:
+ - resources/index.md
+ - project-generation.md
+ - external-links.md
+ - newsletter.md
+- About:
+ - about/index.md
+ - alternatives.md
+ - history-design-future.md
+ - benchmarks.md
+- Help:
+ - help/index.md
+ - help-fastapi.md
+ - contributing.md
- release-notes.md
markdown_extensions:
toc:
@@ -178,9 +229,9 @@ markdown_extensions:
guess_lang: false
mdx_include:
base_path: docs
- admonition:
- codehilite:
- extra:
+ admonition: null
+ codehilite: null
+ extra: null
pymdownx.superfences:
custom_fences:
- name: mermaid
@@ -188,8 +239,8 @@ markdown_extensions:
format: !!python/name:pymdownx.superfences.fence_code_format ''
pymdownx.tabbed:
alternate_style: true
- attr_list:
- md_in_html:
+ attr_list: null
+ md_in_html: null
extra:
analytics:
provider: google
@@ -240,8 +291,12 @@ extra:
name: tr - Tรผrkรงe
- link: /uk/
name: uk
+ - link: /ur/
+ name: ur
- link: /vi/
- name: vi
+ name: vi - Tiแบฟng Viแปt
+ - link: /yo/
+ name: yo - Yorรนbรก
- link: /zh/
name: zh - ๆฑ่ฏญ
extra_css:
diff --git a/docs/en/overrides/main.html b/docs/en/overrides/main.html
index 7e6c0f763..4c7f19fd4 100644
--- a/docs/en/overrides/main.html
+++ b/docs/en/overrides/main.html
@@ -40,6 +40,18 @@
+ 
+
+ 
+
+
-
-## Activer l'accรจs public
-
-Par dรฉfaut, Deta va gรฉrer l'authentification en utilisant des cookies pour votre compte.
-
-Mais une fois que vous รชtes prรชt, vous pouvez le rendre public avecย :
-
-
-
-## En savoir plus
-
-ร un moment donnรฉ, vous voudrez probablement stocker certaines donnรฉes pour votre application d'une maniรจre qui
-persiste dans le temps. Pour cela, vous pouvez utiliser Deta Base, il dispose รฉgalement d'un gรฉnรฉreux **plan gratuit**.
-
-Vous pouvez รฉgalement en lire plus dans la documentation Deta.
diff --git a/docs/fr/docs/external-links.md b/docs/fr/docs/external-links.md
index 002e6d2b2..37b8c5b13 100644
--- a/docs/fr/docs/external-links.md
+++ b/docs/fr/docs/external-links.md
@@ -9,70 +9,21 @@ Voici une liste incomplรจte de certains d'entre eux.
!!! tip "Astuce"
Si vous avez un article, projet, outil, ou quoi que ce soit liรฉ ร **FastAPI** qui n'est actuellement pas listรฉ ici, crรฉez une Pull Request l'ajoutant.
-## Articles
+{% for section_name, section_content in external_links.items() %}
-### Anglais
+## {{ section_name }}
-{% if external_links %}
-{% for article in external_links.articles.english %}
+{% for lang_name, lang_content in section_content.items() %}
+
+### {{ lang_name }}
+
+{% for item in lang_content %}
+
+* {{ item.title }} by {{ item.author }}.
-* {{ article.title }} par {{ article.author }}.
{% endfor %}
-{% endif %}
-
-### Japonais
-
-{% if external_links %}
-{% for article in external_links.articles.japanese %}
-
-* {{ article.title }} par {{ article.author }}.
{% endfor %}
-{% endif %}
-
-### Vietnamien
-
-{% if external_links %}
-{% for article in external_links.articles.vietnamese %}
-
-* {{ article.title }} par {{ article.author }}.
{% endfor %}
-{% endif %}
-
-### Russe
-
-{% if external_links %}
-{% for article in external_links.articles.russian %}
-
-* {{ article.title }} par {{ article.author }}.
-{% endfor %}
-{% endif %}
-
-### Allemand
-
-{% if external_links %}
-{% for article in external_links.articles.german %}
-
-* {{ article.title }} par {{ article.author }}.
-{% endfor %}
-{% endif %}
-
-## Podcasts
-
-{% if external_links %}
-{% for article in external_links.podcasts.english %}
-
-* {{ article.title }} par {{ article.author }}.
-{% endfor %}
-{% endif %}
-
-## Confรฉrences
-
-{% if external_links %}
-{% for article in external_links.talks.english %}
-
-* {{ article.title }} par {{ article.author }}.
-{% endfor %}
-{% endif %}
## Projets
diff --git a/docs/fr/docs/features.md b/docs/fr/docs/features.md
index dcc0e39ed..0c1f6269a 100644
--- a/docs/fr/docs/features.md
+++ b/docs/fr/docs/features.md
@@ -25,7 +25,7 @@ Documentation d'API interactive et interface web d'exploration. Comme le framewo
### Faite en python moderne
-Tout est basรฉ sur la dรฉclaration de type standard de **Python 3.6** (grรขce ร Pydantic). Pas de nouvelles syntaxes ร apprendre. Juste du Python standard et moderne.
+Tout est basรฉ sur la dรฉclaration de type standard de **Python 3.8** (grรขce ร Pydantic). Pas de nouvelles syntaxes ร apprendre. Juste du Python standard et moderne.
Si vous souhaitez un rappel de 2 minutes sur l'utilisation des types en Python (mรชme si vous ne comptez pas utiliser FastAPI), jetez un oeil au tutoriel suivant: [Python Types](python-types.md){.internal-link target=_blank}.
@@ -71,9 +71,9 @@ my_second_user: User = User(**second_user_data)
Tout le framework a รฉtรฉ conรงu pour รชtre facile et intuitif d'utilisation, toutes les dรฉcisions de design ont รฉtรฉ testรฉes sur de nombreux รฉditeurs avant mรชme de commencer le dรฉveloppement final afin d'assurer la meilleure expรฉrience de dรฉveloppement possible.
-Dans le dernier sondage effectuรฉ auprรจs de dรฉveloppeurs python il รฉtait clair que la fonctionnalitรฉ la plus utilisรฉe est "l'autocomplรจtion".
+Dans le dernier sondage effectuรฉ auprรจs de dรฉveloppeurs python il รฉtait clair que la fonctionnalitรฉ la plus utilisรฉe est "lโautocomplรฉtion".
-Tout le framwork **FastAPI** a รฉtรฉ conรงu avec cela en tรชte. L'autocomplรฉtion fonctionne partout.
+Tout le framework **FastAPI** a รฉtรฉ conรงu avec cela en tรชte. L'autocomplรฉtion fonctionne partout.
Vous devrez rarement revenir ร la documentation.
@@ -136,7 +136,7 @@ FastAPI contient un systรจme simple mais extrรชmement puissant d'Starlette. Le code utilisant Starlette que vous ajouterez fonctionnera donc aussi.
-En fait, `FastAPI` est un sous compposant de `Starlette`. Donc, si vous savez dรฉjร comment utiliser Starlette, la plupart des fonctionnalitรฉs fonctionneront de la mรชme maniรจre.
+En fait, `FastAPI` est un sous composant de `Starlette`. Donc, si vous savez dรฉjร comment utiliser Starlette, la plupart des fonctionnalitรฉs fonctionneront de la mรชme maniรจre.
Avec **FastAPI** vous aurez toutes les fonctionnalitรฉs de **Starlette** (FastAPI est juste Starlette sous stรฉroรฏdes):
-* Des performances vraiments impressionnantes. C'est l'un des framework Python les plus rapide, ร รฉgalitรฉ avec **NodeJS** et **GO**.
+* Des performances vraiment impressionnantes. C'est l'un des framework Python les plus rapide, ร รฉgalitรฉ avec **NodeJS** et **GO**.
* Le support des **WebSockets**.
* Le support de **GraphQL**.
* Les tรขches d'arriรจre-plan.
@@ -180,7 +180,7 @@ Inclus des librairies externes basรฉes, aussi, sur Pydantic, servent d' dรฉcorateur de validation
* 100% de couverture de test.
diff --git a/docs/fr/docs/help-fastapi.md b/docs/fr/docs/help-fastapi.md
index 0995721e1..525c699f5 100644
--- a/docs/fr/docs/help-fastapi.md
+++ b/docs/fr/docs/help-fastapi.md
@@ -36,8 +36,8 @@ Vous pouvez :
* Me suivre sur **Twitter**.
* Dites-moi comment vous utilisez FastAPI (j'adore entendre รงa).
* Entendre quand je fais des annonces ou que je lance de nouveaux outils.
-* Vous connectez ร moi sur **Linkedin**.
- * Etre notifiรฉ quand je fais des annonces ou que je lance de nouveaux outils (bien que j'utilise plus souvent Twitte ๐คทโโ).
+* Vous connectez ร moi sur **LinkedIn**.
+ * Etre notifiรฉ quand je fais des annonces ou que je lance de nouveaux outils (bien que j'utilise plus souvent Twitter ๐คทโโ).
* Lire ce que jโรฉcris (ou me suivre) sur **Dev.to** ou **Medium**.
* Lire d'autres idรฉes, articles, et sur les outils que j'ai crรฉรฉs.
* Suivez-moi pour lire quand je publie quelque chose de nouveau.
@@ -84,24 +84,6 @@ Vous pouvez
- 
-
-
-Rejoignez le chat sur Gitter: https://gitter.im/tiangolo/fastapi.
-
-Vous pouvez y avoir des conversations rapides avec d'autres personnes, aider les autres, partager des idรฉes, etc.
-
-Mais gardez ร l'esprit que, comme il permet une "conversation plus libre", il est facile de poser des questions trop gรฉnรฉrales et plus difficiles ร rรฉpondre, de sorte que vous risquez de ne pas recevoir de rรฉponses.
-
-Dans les Issues de GitHub, le modรจle vous guidera pour รฉcrire la bonne question afin que vous puissiez plus facilement obtenir une bonne rรฉponse, ou mรชme rรฉsoudre le problรจme vous-mรชme avant mรชme de le poser. Et dans GitHub, je peux m'assurer que je rรฉponds toujours ร tout, mรชme si cela prend du temps. Je ne peux pas faire cela personnellement avec le chat Gitter. ๐
-
-Les conversations dans Gitter ne sont pas non plus aussi facilement consultables que dans GitHub, de sorte que les questions et les rรฉponses peuvent se perdre dans la conversation.
-
-De l'autre cรดtรฉ, il y a plus de 1000 personnes dans le chat, il y a donc de fortes chances que vous y trouviez quelqu'un ร qui parler, presque tout le temps. ๐
-
## Parrainer l'auteur
Vous pouvez รฉgalement soutenir financiรจrement l'auteur (moi) via GitHub sponsors.
diff --git a/docs/fr/docs/index.md b/docs/fr/docs/index.md
index 7c7547be1..f732fc74c 100644
--- a/docs/fr/docs/index.md
+++ b/docs/fr/docs/index.md
@@ -27,7 +27,7 @@
---
-FastAPI est un framework web moderne et rapide (haute performance) pour la crรฉation d'API avec Python 3.7+, basรฉ sur les annotations de type standard de Python.
+FastAPI est un framework web moderne et rapide (haute performance) pour la crรฉation d'API avec Python 3.8+, basรฉ sur les annotations de type standard de Python.
Les principales fonctionnalitรฉs sont :
@@ -115,7 +115,7 @@ Si vous souhaitez construire une application en-tรชtes.**, **cookies**, **champs de formulaire** et **fichiers**.
* L'utilisation de **contraintes de validation** comme `maximum_length` ou `regex`.
-* Un **systรฉme d'injection de dรฉpendance ** trรจs puissant et facile ร utiliser .
+* Un **systรจme d'injection de dรฉpendance ** trรจs puissant et facile ร utiliser .
* Sรฉcuritรฉ et authentification, y compris la prise en charge de **OAuth2** avec les **jetons JWT** et l'authentification **HTTP Basic**.
* Des techniques plus avancรฉes (mais tout aussi faciles) pour dรฉclarer les **modรจles JSON profondรฉment imbriquรฉs** (grรขce ร Pydantic).
* Intรฉgration de **GraphQL** avec Strawberry et d'autres bibliothรจques.
@@ -450,7 +450,7 @@ Utilisรฉes par Pydantic:
Utilisรฉes par Starlette :
* requests - Obligatoire si vous souhaitez utiliser `TestClient`.
-* jinja2 - Obligatoire si vous souhaitez utiliser la configuration de template par defaut.
+* jinja2 - Obligatoire si vous souhaitez utiliser la configuration de template par dรฉfaut.
* python-multipart - Obligatoire si vous souhaitez supporter le "dรฉcodage" de formulaire avec `request.form()`.
* itsdangerous - Obligatoire pour la prise en charge de `SessionMiddleware`.
* pyyaml - Obligatoire pour le support `SchemaGenerator` de Starlette (vous n'en avez probablement pas besoin avec FastAPI).
diff --git a/docs/fr/docs/python-types.md b/docs/fr/docs/python-types.md
index 4008ed96f..f49fbafd3 100644
--- a/docs/fr/docs/python-types.md
+++ b/docs/fr/docs/python-types.md
@@ -119,7 +119,7 @@ Comme l'รฉditeur connaรฎt le type des variables, vous n'avez pas seulement l'aut
-Maintenant que vous avez connaissance du problรจme, convertissez `age` en chaine de caractรจres grรขce ร `str(age)` :
+Maintenant que vous avez connaissance du problรจme, convertissez `age` en chaรฎne de caractรจres grรขce ร `str(age)` :
```Python hl_lines="2"
{!../../../docs_src/python_types/tutorial004.py!}
diff --git a/docs/fr/docs/tutorial/body.md b/docs/fr/docs/tutorial/body.md
index 1e732d336..89720c973 100644
--- a/docs/fr/docs/tutorial/body.md
+++ b/docs/fr/docs/tutorial/body.md
@@ -98,7 +98,7 @@ Et vous obtenez aussi de la vรฉrification d'erreur pour les opรฉrations incorrec
-Ce n'est pas un hasard, ce framework entier a รฉtรฉ bati avec ce design comme objectif.
+Ce n'est pas un hasard, ce framework entier a รฉtรฉ bรขti avec ce design comme objectif.
Et cela a รฉtรฉ rigoureusement testรฉ durant la phase de design, avant toute implรฉmentation, pour s'assurer que cela fonctionnerait avec tous les รฉditeurs.
diff --git a/docs/fr/docs/tutorial/first-steps.md b/docs/fr/docs/tutorial/first-steps.md
index 224c340c6..e98283f1e 100644
--- a/docs/fr/docs/tutorial/first-steps.md
+++ b/docs/fr/docs/tutorial/first-steps.md
@@ -170,7 +170,7 @@ Si vous crรฉez votre app avec :
{!../../../docs_src/first_steps/tutorial002.py!}
```
-Et la mettez dans un fichier `main.py`, alors vous appeleriez `uvicorn` avec :
+Et la mettez dans un fichier `main.py`, alors vous appelleriez `uvicorn` avec :
+
+---
+
+ใใฆใ**ใใญใปใน**ใจ**ใใญใฐใฉใ **ใจใใ็จ่ชใฎ้ใใ็ขบ่ชใใใจใใใงใใใใญใคใกใณใใซใคใใฆ่ฉฑใ็ถใใพใใ
+
+## ่ตทๅๆใฎๅฎ่ก
+
+ใปใจใใฉใฎๅ ดๅใWeb APIใไฝๆใใใจใใฏใใฏใฉใคใขใณใใใใคใงใใขใฏใปในใงใใใใใซใ**ๅธธใซ**ไธญๆญใใใใใจใชใ**ๅฎ่กใใใ**ใใจใๆใฟใพใใใใกใใใ็นๅฎใฎ็ถๆณใงใฎใฟๅฎ่กใใใใ็นๅฅใช็็ฑใใใๅ ดๅใฏๅฅใงใใใใใฎๆ้ใฎใปใจใใฉใฏใๅธธใซๅฎ่กใใใ**ๅฉ็จๅฏ่ฝ**ใงใใใใจใๆใฟใพใใ
+
+### ใชใขใผใใตใผใใผไธใงใฎๅฎ่ก
+
+ใชใขใผใใตใผใใผ๏ผใฏใฉใฆใใตใผใใผใไปฎๆณใใทใณใชใฉ๏ผใใปใใใขใใใใใจใใซใงใใๆใ็ฐกๅใชใใจใฏใใญใผใซใซใง้็บใใใจใใจๅใใใใซใUvicorn๏ผใพใใฏๅๆงใฎใใฎ๏ผใๆๅใงๅฎ่กใใใใจใงใใ ใใฎๆนๆณใฏ**้็บไธญ**ใซใฏๅฝนใซ็ซใคใจๆใใใพใใ
+
+ใใใใใตใผใใผใธใฎๆฅ็ถใๅใใๅ ดๅใ**ๅฎ่กไธญใฎใใญใปใน**ใฏใใใใใใฆใณใใฆใใพใใงใใใใ
+
+ใใใฆใตใผใใผใๅ่ตทๅใใใๅ ดๅ๏ผใขใใใใผใใใฏใฉใฆใใใญใใคใใผใใใฎใใคใฐใฌใผใทใงใณใฎๅพใชใฉ๏ผใใใใใใใชใใฏใใใซ**ๆฐใฅใใชใใงใใใ**ใใใฎใใใใใญใปในใๆๅใงๅ่ตทๅใใชใใใฐใชใใชใใใจใใๆฐใฅใใชใใงใใใใใคใพใใAPIใฏใใฆใณใใใพใพใชใฎใงใใ๐ฑ
+
+### ่ตทๅๆใซ่ชๅ็ใซๅฎ่ก
+
+ไธ่ฌ็ใซใใตใผใใผใใญใฐใฉใ ๏ผUvicornใชใฉ๏ผใฏใตใผใใผ่ตทๅๆใซ่ชๅ็ใซ้ๅงใใใ**ไบบใฎไปๅ
ฅ**ใๅฟ
่ฆใจใใใซใAPIใจไธ็ทใซใใญใปในใๅธธใซๅฎ่กใใใใใใซใใใใจๆใใใพใ๏ผUvicornใFastAPIใขใใชใๅฎ่กใใใชใฉ๏ผใ
+
+### ๅฅใฎใใญใฐใฉใ ใฎ็จๆ
+
+ใใใๅฎ็พใใใใใซใ้ๅธธใฏ**ๅฅใฎใใญใฐใฉใ **ใ็จๆใใ่ตทๅๆใซใขใใชใฑใผใทใงใณใๅฎ่กใใใใใใซใใพใใใใใฆๅคใใฎๅ ดๅใไปใฎใณใณใใผใใณใใใขใใชใฑใผใทใงใณใไพใใฐใใผใฟใใผในใๅฎ่กใใใใใใซใใพใใ
+
+### ่ตทๅๆใซๅฎ่กใใใใผใซใฎไพ
+
+ๅฎ่กใใใใผใซใฎไพใใใใคใๆใใพใ:
+
+* Docker
+* Kubernetes
+* Docker Compose
+* Swarm ใขใผใใซใใ Docker
+* Systemd
+* Supervisor
+* ใฏใฉใฆใใใญใใคใใผใใตใผใในใฎไธ้จใจใใฆๅ
้จ็ใซๅฆ็
+* ใใฎใปใ...
+
+ๆฌกใฎ็ซ ใงใใใๅ
ทไฝ็ใชไพใๆใใฆใใใพใใ
+
+## ๅ่ตทๅ
+
+่ตทๅๆใซใขใใชใฑใผใทใงใณใๅฎ่กใใใใใจใ็ขบ่ชใใใฎใจๅๆงใซใๅคฑๆๅพใซใขใใชใฑใผใทใงใณใ**ๅ่ตทๅ**ใใใใใจใ็ขบ่ชใใใใจๆใใใพใใ
+
+### ๆใ
ใฏ้้ใใ็ฏใ
+
+็งใใกไบบ้ใฏๅธธใซ**้้ใ**ใ็ฏใใพใใใฝใใใฆใงใขใซใฏใใปใจใใฉๅธธใซ**ใใฐ**ใใใใใ็ฎๆใซ้ ใใใฆใใพใใ๐
+
+### ๅฐใใชใจใฉใผใฏ่ชๅ็ใซๅฆ็ใใใ
+
+FastAPIใงWeb APIใๆง็ฏใใ้ใซใใณใผใใซใจใฉใผใใใๅ ดๅใFastAPIใฏ้ๅธธใใจใฉใผใๅผใ่ตทใใใๅไธใฎใชใฏใจในใใซใจใฉใผใๅซใใพใใ๐ก
+
+ใฏใฉใคใขใณใใฏใใฎใชใฏใจในใใซๅฏพใใฆ**500 Internal Server Error**ใๅใๅใใพใใใใขใใชใฑใผใทใงใณใฏๅฎๅ
จใซใฏใฉใใทใฅใใใฎใงใฏใชใใๆฌกใฎใชใฏใจในใใฎใใใซๅไฝใ็ถใใพใใ
+
+### ้ๅคงใชใจใฉใผ - ใฏใฉใใทใฅ
+
+ใใใใชใใใ**ใขใใชใฑใผใทใงใณๅ
จไฝใใฏใฉใใทใฅใใใใใใชใณใผใใๆธใใฆ**UvicornใจPythonใใฏใฉใใทใฅใใใใใใชใฑใผในใใใใใใใใพใใใ๐ฅ
+
+ใใใงใใใใ็ฎๆใงใจใฉใผใ็บ็ใใใใใจใใฃใฆใใขใใชใฑใผใทใงใณใๅๆญขใใใใพใพใซใใใใชใใงใใใใ ๅฐใชใใจใๅฃใใฆใใชใ*ใในใชใใฌใผใทใงใณ*ใซใคใใฆใฏใ**ๅฎ่กใ็ถใใใ**ใฏใใงใใ
+
+### ใฏใฉใใทใฅๅพใฎๅ่ตทๅ
+
+ใใใใๅฎ่กไธญใฎ**ใใญใปใน**ใใฏใฉใใทใฅใใใใใใชๆฌๅฝใซใฒใฉใใจใฉใผใฎๅ ดๅใๅฐใชใใจใ2ใ3ๅใปใฉใใญใปในใ**ๅ่ตทๅ**ใใใๅค้จใณใณใใผใใณใใๅฟ
่ฆใงใใใใ
+
+!!! tip
+ ...ใจใฏใใใใขใใชใฑใผใทใงใณๅ
จไฝใ**ใใใซใฏใฉใใทใฅใใ**ใฎใงใใใฐใใใคใพใงใๅ่ตทๅใ็ถใใใฎใฏๆๅณใใชใใงใใใใใใใใใใฎๅ ดๅใฏใใใใ้็บไธญใๅฐใชใใจใใใใญใค็ดๅพใซๆฐใฅใใจๆใใใพใใ
+
+ ใใใงใ**ๅฐๆฅ**ใฏใฉใใทใฅใใๅฏ่ฝๆงใใใใใใใงใๅในใฟใผใใใใใใจใซๆๅณใใใใใใชใไธปใชใฑใผในใซ็ฆ็นใๅฝใฆใฆใฟใพใใ
+
+ใใชใใฏใใใใ**ๅค้จใณใณใใผใใณใ**ใใขใใชใฑใผใทใงใณใฎๅ่ตทๅใๆ
ๅฝใใใใจใๆใใจ่ใใพใใ ใชใใชใใใใฎๆ็นใงUvicornใจPythonใไฝฟใฃใๅใใขใใชใฑใผใทใงใณใฏใใงใซใฏใฉใใทใฅใใฆใใใๅใใขใใชใฑใผใทใงใณใฎๅใใณใผใใซๅฏพใใฆไฝใใงใใชใใใใงใใ
+
+### ่ชๅ็ใซๅ่ตทๅใใใใผใซใฎไพ
+
+ใปใจใใฉใฎๅ ดๅใๅ่ฟฐใใ**่ตทๅๆใซใใญใฐใฉใ ใๅฎ่กใใ**ใใใซไฝฟ็จใใใใใผใซใฏใ่ชๅใง**ๅ่ตทๅ**ใใใใจใซใๅฉ็จใใใพใใ
+
+ไพใใฐใๆฌกใฎใใใชใใฎใใใใพใ๏ผ
+
+* Docker
+* Kubernetes
+* Docker Compose
+* Swarm ใขใผใใซใใ Docker
+* Systemd
+* Supervisor
+* ใฏใฉใฆใใใญใใคใใผใใตใผใในใฎไธ้จใจใใฆๅ
้จ็ใซๅฆ็
+* ใใฎใปใ...
+
+## ใฌใใชใฑใผใทใงใณ - ใใญใปในใจใกใขใชใผ
+
+FastAPI ใขใใชใฑใผใทใงใณใงใฏใUvicorn ใฎใใใชใตใผใใผใใญใฐใฉใ ใไฝฟ็จใใ**1ใคใฎใใญใปใน**ใง1ๅบฆใซ่คๆฐใฎใฏใฉใคใขใณใใซๅๆใซๅฏพๅฟใงใใพใใ
+
+ใใใใๅคใใฎๅ ดๅใ่คๆฐใฎใฏใผใซใผใปใใญใปในใๅๆใซๅฎ่กใใใใจ่ใใใงใใใใ
+
+### ่คๆฐใฎใใญใปใน - Worker
+
+ใฏใฉใคใขใณใใฎๆฐใๅไธใฎใใญใปในใงๅฆ็ใงใใๆฐใ่ถ
ใใฆใใ๏ผใใจใใฐไปฎๆณใใทใณใใใใปใฉๅคงใใใชใๅ ดๅ๏ผใใใคใตใผใใผใฎ CPU ใซ**่คๆฐใฎใณใข**ใใใๅ ดๅใๅใใขใใชใฑใผใทใงใณใงๅๆใซ**่คๆฐใฎใใญใปใน**ใๅฎ่กใใใใในใฆใฎใชใฏใจในใใๅๆฃใใใใใจใใงใใพใใ
+
+ๅใAPIใใญใฐใฉใ ใฎ**่คๆฐใฎใใญใปใน**ใๅฎ่กใใๅ ดๅใใใใใฏไธ่ฌ็ใซ**Worker๏ผใฏใผใซใผ**ใจๅผใฐใใพใใ
+
+### ใฏใผใซใผใปใใญใปใน ใจ ใใผใ
+
+
+[HTTPSใซใคใใฆ](./https.md){.internal-link target=_blank}ใฎใใญใฅใกใณใใงใ1ใคใฎใตใผใใผใง1ใคใฎใใผใใจIPใขใใฌในใฎ็ตใฟๅใใใงใชใในใณใงใใใฎใฏ1ใคใฎใใญใปในใ ใใงใใใใจใ่ฆใใฆใใพใใงใใใใ๏ผ
+
+ใใใฏใใพใ ใซๅใใงใใ
+
+ใใฎใใใ**่คๆฐใฎใใญใปใน**ใๅๆใซๆใคใซใฏ**ใใผใใงใชใในใณใใฆใใๅไธใฎใใญใปใน**ใๅฟ
่ฆใงใใใใใใไฝใใใฎๆนๆณใงๅใฏใผใซใผใปใใญใปในใซ้ไฟกใ้ไฟกใใใใจใๆฑใใใใพใใ
+
+### ใใญใปในใใใใฎใกใขใชใผ
+
+ใใฆใใใญใฐใฉใ ใใกใขใชใซใญใผใใใ้ใซใฏใไพใใฐๆฉๆขฐๅญฆ็ฟใขใใซใๅคงใใชใใกใคใซใฎๅ
ๅฎนใๅคๆฐใซๅ
ฅใใใใใๅ ดๅใงใฏใ**ใตใผใใผใฎใกใขใช๏ผRAM๏ผ**ใๅฐใๆถ่ฒปใใพใใ
+
+ใใใฆ่คๆฐใฎใใญใปในใฏ้ๅธธใ**ใกใขใชใๅ
ฑๆใใพใใ**ใใใใฏใๅฎ่กไธญใฎๅใใญใปในใใใใใ็ฌ่ชใฎๅคๆฐใใกใขใช็ญใๆใฃใฆใใใใจใๆๅณใใพใใใคใพใใใณใผใๅ
ใงๅคง้ใฎใกใขใชใๆถ่ฒปใใฆใใๅ ดๅใ**ๅใใญใปใน**ใฏๅ็ญใฎ้ใฎใกใขใชใๆถ่ฒปใใใใจใซใชใใพใใ
+
+### ใตใผใใผใกใขใชใผ
+
+ไพใใฐใใใชใใฎใณใผใใ **1GBใฎใตใคใบใฎๆฉๆขฐๅญฆ็ฟใขใใซ**ใใญใผใใใๅ ดๅใAPIใง1ใคใฎใใญใปในใๅฎ่กใใใจใๅฐใชใใจใ1GBใฎRAMใๆถ่ฒปใใพใใ
+
+ใพใใ**4ใคใฎใใญใปใน**๏ผ4ใคใฎใฏใผใซใผ๏ผใ่ตทๅใใใจใใใใใใ1GBใฎRAMใๆถ่ฒปใใพใใใคใพใใๅ่จใงAPIใฏ**4GBใฎRAM**ใๆถ่ฒปใใใใจใซใชใใพใใ
+
+ใชใขใผใใตใผใใผใไปฎๆณใใทใณใฎRAMใ3GBใใใชใๅ ดๅใ4GBไปฅไธใฎRAMใใญใผใใใใใจใใใจๅ้กใ็บ็ใใพใใ๐จ
+
+### ่คๆฐใใญใปใน - ไพ
+
+ใใฎไพใงใฏใ2ใคใฎ**ใฏใผใซใผใปใใญใปใน**ใ่ตทๅใๅถๅพกใใ**ใใใผใธใฃใผใป ใใญใปใน**ใใใใพใใ
+
+ใใฎใใใผใธใฃใผใป ใใญใปในใฏใใใใใIPใฎ**ใใผใ**ใงใชใในใณใใฆใใใใฎใงใใใใใฆใใในใฆใฎ้ไฟกใใฏใผใซใผใปใใญใปในใซ่ปข้ใใพใใ
+
+ใใใใฎใฏใผใซใผใปใใญใปในใฏใใขใใชใฑใผใทใงใณใๅฎ่กใใใใฎใงใใใ**ใชใฏใจในใ**ใๅใใฆ**ใฌในใใณใน**ใ่ฟใใใใฎไธป่ฆใช่จ็ฎใ่กใใใใชใใๅคๆฐใซๅ
ฅใใใใฎใฏไฝใงใRAMใซใญใผใใใพใใ
+
+
+
+ใใใฆใใกใใใๅใใใทใณใงใฏใใใชใใฎใขใใชใฑใผใทใงใณใจใฏๅฅใซใ**ไปใฎใใญใปใน**ใๅฎ่กใใใฆใใใงใใใใ
+
+่ๅณๆทฑใใใจใซใๅใใญใปในใไฝฟ็จใใ**CPU**ใฎๅฒๅใฏๆ้ใจใจใใซๅคงใใ**ๅคๅ**ใใๅฏ่ฝๆงใใใใพใใใ**ใกใขใช๏ผRAM๏ผ**ใฏ้ๅธธใๅคใใๅฐใชใใ**ๅฎๅฎ**ใใพใใ
+
+ๆฏๅๅ็จๅบฆใฎ่จ็ฎใ่กใAPIใใใใๅคใใฎใฏใฉใคใขใณใใใใใฎใงใใใฐใ**CPUไฝฟ็จ็**ใใใใใ**ๅฎๅฎ**ใใใงใใใ๏ผๅธธใซๆฅๆฟใซไธไธใใใฎใงใฏใชใ๏ผใ
+
+### ใฌใใชใฑใผใทใงใณใปใใผใซใจๆฆ็ฅใฎไพ
+
+ใใใๅฎ็พใใใซใฏใใใคใใฎใขใใญใผใใใใใพใใใๅ
ทไฝ็ใชๆฆ็ฅใซใคใใฆใฏๆฌกใฎ็ซ (Dockerใใณใณใใใฎ็ซ ใชใฉ)ใง่ฉณใใ่ชฌๆใใพใใ
+
+่ๆ
ฎใในใไธปใชๅถ็ดใฏใ**ใใใชใใฏIP**ใฎ**ใใผใ**ใๅฆ็ใใ**ๅไธใฎ**ใณใณใใผใใณใใๅญๅจใใชใใใฐใชใใชใใจใใใใจใงใใ
+
+ใใใฆใใฌใใชใฑใผใใใใ**ใใญใปใน/ใฏใผใซใผ**ใซ้ไฟกใ**้ไฟก**ใใๆนๆณใๆใคๅฟ
่ฆใใใใพใใ
+
+่ใใใใ็ตใฟๅใใใจๆฆ็ฅใใใใคใ็ดนไปใใพใ๏ผ
+
+* **Gunicorn**ใ**Uvicornใฏใผใซใผ**ใ็ฎก็
+ * Gunicornใฏ**IP**ใจ**ใใผใ**ใใชใในใณใใ**ใใญใปในใใใผใธใฃ**ใงใใฌใใชใฑใผใทใงใณใฏ**่คๆฐใฎUvicornใฏใผใซใผใปใใญใปใน**ใๆใคใใจใซใใฃใฆ่กใใใใ
+* **Uvicorn**ใ**Uvicornใฏใผใซใผ**ใ็ฎก็
+ * 1ใคใฎUvicornใฎ**ใใญใปในใใใผใธใฃใผ**ใ**IP**ใจ**ใใผใ**ใใชใในใณใใ**่คๆฐใฎUvicornใฏใผใซใผใปใใญใปใน**ใ่ตทๅใใใ
+* **Kubernetes**ใใใฎไปใฎๅๆฃ**ใณใณใใใปใทในใใ **
+ * **Kubernetes**ใฌใคใคใผใฎไฝใใ**IP**ใจ**ใใผใ**ใใชใในใณใใใใฌใใชใฑใผใทใงใณใฏใ**่คๆฐใฎใณใณใใ**ใซใใใใ**1ใคใฎUvicornใใญใปใน**ใๅฎ่กใใใใใจใง่กใใใใ
+* **ใฏใฉใฆใใปใตใผใใน**ใซใใใฌใใชใฑใผใทใงใณ
+ * ใฏใฉใฆใใปใตใผใในใฏใใใใ**ใใชใใฎใใใซใฌใใชใฑใผใทใงใณใๅฆ็**ใใพใใ**ๅฎ่กใใใใญใปใน**ใไฝฟ็จใใ**ใณใณใใใคใกใผใธ**ใๅฎ็พฉใงใใใใใใใพใใใใใใใใซใใใใใใฏใใใใ**ๅไธใฎUvicornใใญใปใน**ใงใใใใฏใฉใฆใใตใผใในใฏใใฎใฌใใชใฑใผใทใงใณใๆ
ๅฝใใใงใใใใ
+
+!!! tip
+ ใใใใฎ**ใณใณใใ**ใDockerใใใฆKubernetesใซ้ขใใ้
็ฎใใใพใ ใใพใๆๅณใใชใใฆใใชใใฆใๅฟ้
ใใชใใงใใ ใใใ
+
+
+ ใณใณใใใปใคใกใผใธใDockerใKubernetesใชใฉใซใคใใฆใฏใๆฌกใฎ็ซ ใง่ฉณใใ่ชฌๆใใพใ: [ใณใณใใๅ
ใฎFastAPI - Docker](./docker.md){.internal-link target=_blank}.
+
+## ้ๅงๅใฎไบๅใฎในใใใ
+
+ใขใใชใฑใผใทใงใณใ**้ๅงใใๅ**ใซใใใใคใใฎในใใใใๅฎ่กใใใๅ ดๅใๅคใใใใพใใ
+
+ไพใใฐใ**ใใผใฟใใผในใปใใคใฐใฌใผใทใงใณ** ใๅฎ่กใใใใใใใใพใใใ
+
+ใใใใปใจใใฉใฎๅ ดๅใใใใใฎๆ้ ใ**1ๅบฆ**ใซๅฎ่กใใใใจ่ใใใงใใใใ
+
+ใใฎใใใใขใใชใฑใผใทใงใณใ้ๅงใใๅใฎ**ไบๅใฎในใใใ**ใๅฎ่กใใ**ๅไธใฎใใญใปใน**ใ็จๆใใใใจๆใใใพใใ
+
+ใใใฆใใใใใฎไบๅใฎในใใใใๅฎ่กใใฆใใใฎใๅไธใฎใใญใปในใงใใใใจใ็ขบ่ชใใๅฟ
่ฆใใใใพใใใใฎใใจใฏใใฎๅพใขใใชใฑใผใทใงใณ่ชไฝใฎใใใซ**่คๆฐใฎใใญใปใน**๏ผ่คๆฐใฎใฏใผใซใผ๏ผใ่ตทๅใใๅ ดๅใๅๆงใงใใ
+
+ใใใใฎในใใใใ**่คๆฐใฎใใญใปใน**ใซใใฃใฆๅฎ่กใใใๅ ดๅใ**ไธฆๅ**ใซๅฎ่กใใใใใจใซใใฃใฆไฝๆฅญใ**้่ค**ใใใใจใซใชใใพใใใใใฆใใใใใฎในใใใใใใผใฟใใผในใฎใใคใฐใฌใผใทใงใณใฎใใใช็น็ดฐใชใใฎใงใใฃใๅ ดๅใไบใใซ็ซถๅใๅผใ่ตทใใๅฏ่ฝๆงใใใใพใใ
+
+ใใกใใใไบๅใฎในใใใใไฝๅบฆใๅฎ่กใใฆใๅ้กใใชใๅ ดๅใใใใใใฎ้ใฏๅฏพๅฆใใใชใๆฅฝใซใชใใพใใ
+
+!!! tip
+ ใพใใใปใใใขใใใซใใฃใฆใฏใใขใใชใฑใผใทใงใณใ้ๅงใใๅใฎ**ไบๅใฎในใใใ**ใๅฟ
่ฆใชใๅ ดๅใใใใใจใ่ฆใใฆใใใฆใใ ใใใ
+
+ ใใฎๅ ดๅใฏใใใฎใใใชใใจใๅฟ้
ใใๅฟ
่ฆใฏใชใใงใใ๐คท
+
+### ไบๅในใใใใฎๆฆ็ฅไพ
+
+ใใใฏ**ใทในใใ ใ**ใใใญใคใใๆนๆณใซ**ๅคงใใไพๅญ**ใใใ ใใใใใใใใใใญใฐใฉใ ใฎ่ตทๅๆนๆณใๅ่ตทๅใฎๅฆ็ใชใฉใซใ้ขไฟใใฆใใใงใใใใ
+
+่ใใใใใขใคใใขใใใใคใๆใใฆใฟใพใ๏ผ
+
+* ใขใใชใณใณใใใฎๅใซๅฎ่กใใใKubernetesใฎInitใณใณใใ
+* ไบๅใฎในใใใใๅฎ่กใใใขใใชใฑใผใทใงใณใ่ตทๅใใbashในใฏใชใใ
+ * ๅฉ็จใใbashในใฏใชใใใ่ตทๅ๏ผๅ่ตทๅใใใใใจใฉใผใๆคๅบใใใใใๆนๆณใฏไปฅๅใจใใฆๅฟ
่ฆใซใชใใงใใใใ
+
+!!! tip
+
+ ใณใณใใใไฝฟใฃใๅ
ทไฝ็ใชไพใซใคใใฆใฏใๆฌกใฎ็ซ ใง็ดนไปใใพใ: [ใณใณใใๅ
ใฎFastAPI - Docker](./docker.md){.internal-link target=_blank}.
+
+## ใชใฝใผในใฎๅฉ็จ
+
+ใใชใใฎใตใผใใผใฏ**ใชใฝใผใน**ใงใใใใใญใฐใฉใ ใๅฎ่กใCPUใฎ่จ็ฎๆ้ใๅฉ็จๅฏ่ฝใชRAMใกใขใชใๆถ่ฒปใพใใฏ**ๅฉ็จ**ใใใใจใใงใใพใใ
+
+ใทในใใ ใชใฝใผในใใฉใใใใๆถ่ฒป๏ผๅฉ็จใใใใงใใ๏ผ ใๅฐใชใๆนใ่ฏใใใจ่ใใใฎใฏ็ฐกๅใใใใใชใใงใใใๅฎ้ใซใฏใ**ใฏใฉใใทใฅใใใซๅฏ่ฝใช้ใ**ๆๅคง้ใซๆดป็จใใใใงใใใใ
+
+3ๅฐใฎใตใผใใผใซใ้ใๆใฃใฆใใใซใ้ขใใใใใใฎRAMใจCPUใๅฐใใใไฝฟใฃใฆใใชใใจใใใใใใใใ**ใ้ใ็ก้งใซใใฆใใ** ๐ธใใใใใ**ใตใผใใผใฎ้ปๅใ็ก้งใซใใฆใใ** ๐ใใจใซใชใใงใใใใ
+
+ใใฎๅ ดๅใฏใใตใผใใผใ2ๅฐใ ใใซใใฆใใใฎใชใฝใผใน๏ผCPUใใกใขใชใใใฃในใฏใใใใใฏใผใฏๅธฏๅๅน
ใชใฉ๏ผใใใ้ซใๅฒๅใงไฝฟ็จใใๆนใใใใงใใใใ
+
+ไธๆนใ2ๅฐใฎใตใผใใผใใใใใใฎCPUใจRAMใฎ**100%ใไฝฟ็จใใฆใใ**ๅ ดๅใใใๆ็นใง1ใคใฎใใญใปในใใใๅคใใฎใกใขใชใ่ฆๆฑใใใตใผใใผใฏใใฃในใฏใใใกใขใชใใจใใฆไฝฟ็จใใชใใจใใใพใใใ๏ผไฝๅๅใ้
ใใชใๅฏ่ฝๆงใใใใพใใ๏ผ
+ใใใใฏ**ใฏใฉใใทใฅ**ใใใใจใใใใฐใใใใใฏใใใใญใปในใไฝใใใฎ่จ็ฎใใใๅฟ
่ฆใใใใใใใฆCPUใๅใณ็ฉบใใพใงๅพ
ใใชใใใฐใชใใชใใใใใใพใใใ
+
+ใใฎๅ ดๅใ**1ใคไฝๅใชใตใผใใผ**ใ็จๆใใใใฎไธใงใใใคใใฎใใญใปในใๅฎ่กใใใในใฆใฎใตใผใใผใ**ๅๅใชRAMใจCPUๆ้ใๆใคใใใซใใ**ใฎใใใใงใใใใ
+
+ใพใใไฝใใใฎ็็ฑใงAPIใฎๅฉ็จใๆฅๅขใใๅฏ่ฝๆงใใใใพใใใใใใใใใใใๆต่กใฃใใฎใใใใใชใใใไปใฎใตใผใในใใใใใไฝฟใๅงใใใฎใใใใใชใใงใใใใฎใใใชๅ ดๅใซๅใใฆใไฝๅใชใชใฝใผในใ็จๆใใฆใใใจๅฎๅฟใงใใใใ
+
+ไพใใฐใใชใฝใผในไฝฟ็จ็ใฎ**50%ใใ90%ใฎ็ฏๅฒ**ใง**ไปปๆใฎๆฐๅญ**ใใฟใผใฒใใใจใใใใจใใงใใพใใ
+
+้่ฆใชใฎใฏใใใใญใคใกใณใใๅพฎ่ชฟๆดใใใใใซใฟใผใฒใใใ่จญๅฎใๆธฌๅฎใใใใจใใใใใใไฝฟ็จใใใไธป่ฆใช่ฆ็ด ใงใใใใจใงใใ
+
+`htop`ใฎใใใชๅ็ดใชใใผใซใไฝฟใฃใฆใใตใผใใผใงไฝฟ็จใใใฆใใCPUใRAMใใใใใฏๅใใญใปในใงไฝฟ็จใใใฆใใ้ใ่ฆใใใจใใงใใพใใใใใใฏใใใ่ค้ใช็ฃ่ฆใใผใซใไฝฟใฃใฆใใตใผใใซๅๆฃใใฆไฝฟ็จใใใใจใใงใใพใใ
+
+## ใพใจใ
+
+ใขใใชใฑใผใทใงใณใฎใใใญใคๆนๆณใๆฑบๅฎใใ้ใซใ่ๆ
ฎใในใใงใใใไธป่ฆใชใณใณใปใใใฎใใใคใใ็ดนไปใใฆใใใพใใ๏ผ
+
+* ใปใญใฅใชใใฃ - HTTPS
+* ่ตทๅๆใฎๅฎ่ก
+* ๅ่ตทๅ
+* ใฌใใชใฑใผใทใงใณ๏ผๅฎ่กไธญใฎใใญใปในๆฐ๏ผ
+* ใกใขใชใผ
+* ้ๅงๅใฎไบๅในใใใ
+
+ใใใใฎ่ใๆนใจใใฎ้ฉ็จๆนๆณใ็่งฃใใใใจใงใใใใญใคใกใณใใ่จญๅฎใใใ่ชฟๆดใใใใใ้ใซๅฟ
่ฆใช็ดๆ็ใชๅคๆญใใงใใใใใซใชใใฏใใงใใ๐ค
+
+ๆฌกใฎใปใฏใทใงใณใงใฏใใใชใใๅใๅพใๆฆ็ฅใซใคใใฆใใใๅ
ทไฝ็ใชไพใๆใใพใใ๐
diff --git a/docs/ja/docs/deployment/deta.md b/docs/ja/docs/deployment/deta.md
deleted file mode 100644
index 723f169a0..000000000
--- a/docs/ja/docs/deployment/deta.md
+++ /dev/null
@@ -1,240 +0,0 @@
-# Deta ใซใใใญใค
-
-ใใฎใปใฏใทใงใณใงใฏใ**FastAPI** ใขใใชใฑใผใทใงใณใ Deta ใฎ็กๆใใฉใณใๅฉ็จใใฆใ็ฐกๅใซใใใญใคใใๆนๆณใๅญฆ็ฟใใพใใ๐
-
-ๆ่ฆๆ้ใฏ็ด**10ๅ**ใงใใ
-
-!!! info "ๅ่"
- Deta ใฏ **FastAPI** ใฎในใใณใตใผใงใใ๐
-
-## ใใผใทใใฏใช **FastAPI** ใขใใช
-
-* ใขใใชใฎใใใฎใใฃใฌใฏใใช (ไพใใฐ `./fastapideta/`) ใไฝๆใใใใฎไธญใซๅ
ฅใฃใฆใใ ใใใ
-
-### FastAPI ใฎใณใผใ
-
-* ไปฅไธใฎ `main.py` ใใกใคใซใไฝๆใใฆใใ ใใ:
-
-```Python
-from fastapi import FastAPI
-
-app = FastAPI()
-
-
-@app.get("/")
-def read_root():
- return {"Hello": "World"}
-
-
-@app.get("/items/{item_id}")
-def read_item(item_id: int):
- return {"item_id": item_id}
-```
-
-### Requirements
-
-ใงใฏใๅใใใฃใฌใฏใใชใซไปฅไธใฎ `requirements.txt` ใใกใคใซใไฝๆใใฆใใ ใใ:
-
-```text
-fastapi
-```
-
-!!! tip "่ฑ็ฅ่ญ"
- ใขใใชใฎใญใผใซใซใในใใฎใใใซ Uvicorn ใใคใณในใใผใซใใใใชใใใใใใพใใใใDeta ใธใฎใใใญใคใซใฏไธ่ฆใงใใ
-
-### ใใฃใฌใฏใใชๆง้
-
-ไปฅไธใฎ2ใคใฎใใกใคใซใจ1ใคใฎ `./fastapideta/` ใใฃใฌใฏใใชใใใใฏใใงใ:
-
-```
-.
-โโโ main.py
-โโโ requirements.txt
-```
-
-## Detaใฎ็กๆใขใซใฆใณใใฎไฝๆ
-
-ใใใงใฏใDetaใฎ็กๆใขใซใฆใณใใไฝๆใใพใใใใๅฟ
่ฆใชใใฎใฏใกใผใซใขใใฌในใจใในใฏใผใใ ใใงใใ
-
-ใฏใฌใธใใใซใผใใใๅฟ
่ฆใใใพใใใ
-
-## CLIใฎใคใณในใใผใซ
-
-ใขใซใฆใณใใๅๅพใใใใDeta CLI ใใคใณในใใผใซใใฆใใ ใใ:
-
-=== "Linux, macOS"
-
-
-
-## ใใใชใใฏใขใฏใปในใฎๆๅนๅ
-
-ใใใฉใซใใงใฏใDeta ใฏใฏใใญใผใ็จใใฆใขใซใฆใณใใฎ่ช่จผใ่กใใพใใ
-
-ใใใใๆบๅใๆดใใฐใไปฅไธใฎๆงใซๅ
ฌ้ใงใใพใ:
-
-
-
-## ใใใซ่ฉณใใ็ฅใ
-
-ๆงใ
ใช็ฎๆใงๆฐธ็ถ็ใซใใผใฟใไฟๅญใใใใชใใงใใใใใใฎใใใซใฏ Deta Base ใไฝฟ็จใงใใพใใๆใใฟใชใ **็กๆๅฉ็จๆ ** ใใใใพใใ
-
-่ฉณใใใฏ Deta ใใญใฅใกใณใใๅ็
งใใฆใใ ใใใ
diff --git a/docs/ja/docs/deployment/docker.md b/docs/ja/docs/deployment/docker.md
index f10312b51..ca9dedc3c 100644
--- a/docs/ja/docs/deployment/docker.md
+++ b/docs/ja/docs/deployment/docker.md
@@ -1,71 +1,157 @@
-# Dockerใไฝฟ็จใใใใใญใค
+# ใณใณใใๅ
ใฎFastAPI - Docker
-ใใฎใปใฏใทใงใณใงใฏไปฅไธใฎไฝฟใๆนใฎ็ดนไปใจใฌใคใใธใฎใชใณใฏใ็ขบ่ชใงใใพใ:
+FastAPIใขใใชใฑใผใทใงใณใใใใญใคใใๅ ดๅใไธ่ฌ็ใชใขใใญใผใใฏ**Linuxใณใณใใใปใคใกใผใธ**ใใใซใใใใใจใงใใ
-* **5ๅ**็จๅบฆใงใ**FastAPI** ใฎใขใใชใฑใผใทใงใณใใใใใฉใผใใณในใๆๅคง้ใซ็บๆฎใใDockerใคใกใผใธ (ใณใณใใ)ใซใใใ
-* (ใชใใทใงใณ) ้็บ่
ใจใใฆๅฟ
่ฆใช็ฏๅฒใงHTTPSใ็่งฃใใใ
-* **20ๅ**็จๅบฆใงใ่ชๅ็ใชHTTPS็ๆใจใจใใซDockerใฎSwarmใขใผใ ใฏใฉในใฟใใปใใใขใใใใ (ๆ5ใใซใฎใทใณใใซใชใตใผใใผไธใง)ใ
-* **10ๅ**็จๅบฆใงใDockerใฎSwarmใขใผใ ใฏใฉในใฟใไฝฟใฃใฆใHTTPSใชใฉใไฝฟ็จใใๅฎๅ
จใช**FastAPI** ใขใใชใฑใผใทใงใณใฎไฝๆใจใใใญใคใ
+ๅบๆฌ็ใซใฏ **Docker**ใ็จใใฆ่กใใใพใใ็ๆใใใใณใณใใใปใคใกใผใธใฏใใใใคใใฎๆนๆณใฎใใใใใงใใใญใคใงใใพใใ
-ใใใญใคใฎใใใซใ**Docker** ใๅฉ็จใงใใพใใใปใญใฅใชใใฃใๅ็พๆงใ้็บใฎใทใณใใซใใชใฉใซๅฉ็นใใใใพใใ
+Linuxใณใณใใใฎไฝฟ็จใซใฏใ**ใปใญใฅใชใใฃ**ใ**ๅๅพฉๅฏ่ฝๆง๏ผใฌใใชใซใใชใใฃ๏ผ**ใ**ใทใณใใชใทใใฃ**ใชใฉใใใใคใใฎๅฉ็นใใใใพใใ
-Dockerใไฝฟใๅ ดๅใๅ
ฌๅผใฎDockerใคใกใผใธใๅฉ็จใงใใพใ:
+!!! tip
+ TODO: ใชใใ้ท็งปใงใใชใ
+ ใๆฅใใงใใใงใซใใใใฎๆ
ๅ ฑใใๅญใใงใใ๏ผ [ไปฅไธใฎ`Dockerfile`ใฎ็ฎๆ๐](#build-a-docker-image-for-fastapi)ใธใธใฃใณใใใฆใใ ใใใ
-## tiangolo/uvicorn-gunicorn-fastapi
-
-ใใฎใคใกใผใธใฏใ่ชๅใใฅใผใใณใฐใๆฉๆงใๅซใใงใใพใใ็ ็ฒใๆใใใจใชใใใใ ใณใผใใๅ ใใใ ใใง่ชๅ็ใซ้ซใใใฉใผใใณในใๅฎ็พใงใใพใใ
-
-ใใ ใใ็ฐๅขๅคๆฐใ่จญๅฎใใกใคใซใไฝฟใฃใฆๅ
จใฆใฎ่จญๅฎใฎๅคๆดใๆดๆฐใ่กใใพใใ
-
-!!! tip "่ฑ็ฅ่ญ"
- ๅ
จใฆใฎ่จญๅฎใจใชใใทใงใณใ็ขบ่ชใใใซใฏใDockerใคใกใผใธใใผใธใ้ใใฆไธใใ: tiangolo/uvicorn-gunicorn-fastapi.
-
-## `Dockerfile` ใฎไฝๆ
-
-* ใใญใธใงใฏใใใฃใฌใฏใใชใธ็งปๅใ
-* ไปฅไธใฎ`Dockerfile` ใไฝๆ:
+
+
+### TLS Handshake ใฎ้ๅง
+
+ใใฉใฆใถใฏIPใขใใฌในใจ**ใใผใ443**๏ผHTTPSใใผใ๏ผใง้ไฟกใใพใใ
+
+้ไฟกใฎๆๅใฎ้จๅใฏใใฏใฉใคใขใณใใจใตใผใใผ้ใฎๆฅ็ถใ็ขบ็ซใใไฝฟ็จใใๆๅท้ตใชใฉใๆฑบใใใ ใใงใใ
+
+
+
+TLSๆฅ็ถใ็ขบ็ซใใใใใฎใฏใฉใคใขใณใใจใตใผใใผ้ใฎใใฎใใใจใใฏใ**TLSใใณใใทใงใคใฏ**ใจๅผใฐใใพใใ
+
+### SNIๆกๅผตๆฉ่ฝไปใใฎTLS
+
+ใตใผใใผๅ
ใฎ**1ใคใฎใใญใปใน**ใ ใใใ็นๅฎ ใฎ**IPใขใใฌใน**ใฎ็นๅฎใฎ**ใใผใ** ใงๅพ
ใกๅใใใใจใใงใใพใใ
+
+ๅใIPใขใใฌในใฎไปใฎใใผใใงไปใฎใใญใปในใใชใในใณใใฆใใๅฏ่ฝๆงใใใใพใใใIPใขใใฌในใจใใผใใฎ็ตใฟๅใใใใจใซ1ใคใ ใใงใใ
+
+TLS๏ผHTTPS๏ผใฏใใใฉใซใใง`443`ใจใใ็นๅฎใฎใใผใใไฝฟ็จใใใใคใพใใใใใๅฟ
่ฆใชใใผใใงใใ
+
+ใใฎใใผใใใชใในใณใงใใใฎใฏ1ใคใฎใใญใปในใ ใใชใฎใงใใใใๅฎ่กใใใใญใปในใฏ**TLS Termination Proxy**ใจใชใใพใใ
+
+TLS Termination Proxyใฏใ1ใคไปฅไธใฎ**TLS่จผๆๆธ**๏ผHTTPS่จผๆๆธ๏ผใซใขใฏใปในใงใใพใใ
+
+ๅ่ฟฐใใ**SNIๆกๅผตๆฉ่ฝ**ใไฝฟ็จใใฆใTLS Termination Proxy ใฏใๅฉ็จๅฏ่ฝใชTLS (HTTPS)่จผๆๆธใฎใฉใใๆฅ็ถๅ
ใจใใฆไฝฟ็จใในใใใใใงใใฏใใใฏใฉใคใขใณใใๆๅพ
ใใใใกใคใณใซไธ่ดใใใใฎใไฝฟ็จใใพใใ
+
+ไปๅใฏใ`someapp.example.com`ใฎ่จผๆๆธใไฝฟใใใจใซใชใใพใใ
+
+
+
+ใฏใฉใคใขใณใใฏใใใฎTLS่จผๆๆธใ็ๆใใใจใณใใฃใใฃ๏ผใใฎๅ ดๅใฏLet's Encryptใงใใใใใใซใคใใฆใฏๅพ่ฟฐใใพใ๏ผใใใงใซ**ไฟก้ ผ**ใใฆใใใใใใใฎ่จผๆๆธใๆๅนใงใใใใจใ**ๆค่จผ**ใใใใจใใงใใพใใ
+
+ๆฌกใซ่จผๆๆธใไฝฟ็จใใฆใใฏใฉใคใขใณใใจTLS Termination Proxy ใฏใ **TCP้ไฟก**ใฎๆฎใใ**ใฉใฎใใใซๆๅทๅใใใใๆฑบๅฎ**ใใพใใใใใง**TLSใใณใใทใงใคใฏ**ใฎ้จๅใๅฎไบใใพใใ
+
+ใใฎๅพใใฏใฉใคใขใณใใจใตใผใใผใฏ**ๆๅทๅใใใTCPๆฅ็ถ**ใๆใกใพใใใใใฆใใใฎๆฅ็ถใไฝฟใฃใฆๅฎ้ใฎ**HTTP้ไฟก**ใ้ๅงใใใใจใใงใใพใใ
+
+ใใใ**HTTPS**ใงใใใ็ด็ฒใช๏ผๆๅทๅใใใฆใใชใ๏ผTCPๆฅ็ถใงใฏใชใใ**ใปใญใฅใขใชTLSๆฅ็ถ**ใฎไธญใซ**HTTP**ใใใใ ใใงใใ
+
+!!! tip
+ ้ไฟกใฎๆๅทๅใฏใHTTPใฌใใซใงใฏใชใใ**TCPใฌใใซ**ใง่กใใใใใจใซๆณจๆใใฆใใ ใใใ
+
+### HTTPS ใชใฏใจในใ
+
+ใใใงใฏใฉใคใขใณใใจใตใผใใผ๏ผๅ
ทไฝ็ใซใฏใใฉใฆใถใจTLS Termination Proxy๏ผใฏ**ๆๅทๅใใใTCPๆฅ็ถ**ใๆใคใใจใซใชใใ**HTTP้ไฟก**ใ้ๅงใใใใจใใงใใพใใ
+
+ใใใงใใฏใฉใคใขใณใใฏ**HTTPSใชใฏใจในใ**ใ้ไฟกใใพใใใใใฏใๆๅทๅใใใTLSใณใใฏใทใงใณใไปใใๅใชใHTTPใชใฏใจในใใงใใ
+
+
+
+### ใชใฏใจในใใฎๅพฉๅทๅ
+
+TLS Termination Proxy ใฏใๅๆใๅใใฆใใๆๅทๅใไฝฟ็จใใฆใ**ใชใฏใจในใใๅพฉๅทๅ**ใใ**ใใฌใผใณ (ๅพฉๅทๅใใใ) HTTP ใชใฏใจในใ** ใใขใใชใฑใผใทใงใณใๅฎ่กใใฆใใใใญใปใน (ไพใใฐใFastAPI ใขใใชใฑใผใทใงใณใๅฎ่กใใฆใใ Uvicorn ใๆใคใใญใปใน) ใซ้ไฟกใใพใใ
+
+
+
+### HTTP ใฌในใใณใน
+
+ใขใใชใฑใผใทใงใณใฏใชใฏใจในใใๅฆ็ใใ**ใใฌใผใณ(ๆๅทๅใใใฆใใชใ)HTTPใฌในใใณใน** ใTLS Termination Proxyใซ้ไฟกใใพใใ
+
+
+
+### HTTPS ใฌในใใณใน
+
+TLS Termination Proxyใฏๆฌกใซใไบๅใซๅๆใๅใใฆใใๆๅท(`someapp.example.com`ใฎ่จผๆๆธใใๅงใพใ)ใไฝฟใฃใฆ**ใฌในใใณในใๆๅทๅใ**ใใใฉใฆใถใซ้ใ่ฟใใ
+
+ใใฎๅพใใฉใฆใถใงใฏใใฌในใใณในใๆๅนใงๆญฃใใๆๅทใญใผใงๆๅทๅใใใฆใใใใจใชใฉใๆค่จผใใพใใใใใฆใใใฉใฆใถใฏใฌในใใณในใ**ๅพฉๅทๅ**ใใฆๅฆ็ใใพใใ
+
+
+
+ใฏใฉใคใขใณใ๏ผใใฉใฆใถ๏ผใฏใใฌในใใณในใๆญฃใใใตใผใใผใใๆฅใใใจใ็ฅใใใจใใงใใพใใ ใชใใชใใใใฎใตใผใใผใฏใไปฅๅใซ**HTTPS่จผๆๆธ**ใไฝฟใฃใฆๅๆใใๆๅทใไฝฟใฃใฆใใใใใงใใ
+
+### ่คๆฐใฎใขใใชใฑใผใทใงใณ
+
+ๅใใตใผใใผ๏ผใพใใฏ่คๆฐใฎใตใผใใผ๏ผใซใไพใใฐไปใฎAPIใใญใฐใฉใ ใใใผใฟใใผในใชใฉใ**่คๆฐใฎใขใใชใฑใผใทใงใณ**ใๅญๅจใใๅฏ่ฝๆงใใใใพใใ
+
+็นๅฎใฎIPใจใใผใ๏ผใใฎไพใงใฏTLS Termination Proxy๏ผใๆฑใใใจใใงใใใฎใฏ1ใคใฎใใญใปในใ ใใงใใใไปใฎใขใใชใฑใผใทใงใณ/ใใญใปในใใๅใ**ใใใชใใฏIPใจใใผใ**ใฎ็ตใฟๅใใใไฝฟ็จใใใใจใใชใ้ใใใตใผใใผไธใงๅฎ่กใใใใจใใงใใพใใ
+
+
+
+ใใใใใฐใTLS Termination Proxy ใฏใ**่คๆฐใฎใใกใคใณ**ใ่คๆฐใฎใขใใชใฑใผใทใงใณใฎHTTPSใจ่จผๆๆธใๅฆ็ใใใใใใใฎใฑใผในใง้ฉๅใชใขใใชใฑใผใทใงใณใซใชใฏใจในใใ้ไฟกใใใใจใใงใใพใใ
+
+### ่จผๆๆธใฎๆดๆฐ
+
+ๅฐๆฅใฎใใๆ็นใงใๅ่จผๆๆธใฏ๏ผๅๅพๅพ็ด3ใถๆใง๏ผ**ๅคฑๅน**ใใพใใ
+
+ใใฎๅพใLet's Encryptใจ้ไฟกใใๅฅใฎใใญใฐใฉใ ๏ผๅฅใฎใใญใฐใฉใ ใงใใๅ ดๅใใใใฐใๅใTLS Termination Proxyใงใใๅ ดๅใใใ๏ผใซใใฃใฆใ่จผๆๆธใๆดๆฐใใพใใ
+
+
+
+**TLS่จผๆๆธ**ใฏใIPใขใใฌในใงใฏใชใใ**ใใกใคใณๅใซ้ข้ฃไปใใใใฆ**ใใพใใ
+
+ใใใใฃใฆใ่จผๆๆธใๆดๆฐใใใใใซใๆดๆฐใใญใฐใฉใ ใฏใ่ช่จผๅฑ๏ผLet's Encrypt๏ผใซๅฏพใใฆใ**ใใฎใใกใคใณใๆฌๅฝใซใๆๆใใใ็ฎก็ใใฆใใ**ใใจใ**่จผๆ**ใใๅฟ
่ฆใใใใพใใ
+
+ใใฎใใใซใใพใใใพใใพใชใขใใชใฑใผใทใงใณใฎใใผใบใซๅฏพๅฟใใใใใซใใใใคใใฎๆนๆณใใใใพใใใใไฝฟใใใๆนๆณใจใใฆใฏ:
+
+* **ใใใคใใฎDNSใฌใณใผใใไฟฎๆญฃใใพใใ**
+ * ใใใใใใใใซใฏใๆดๆฐใใญใฐใฉใ ใฏDNSใใญใใคใใผใฎAPIใใตใใผใใใๅฟ
่ฆใใใใพใใใใใใฃใฆใไฝฟ็จใใฆใใDNSใใญใใคใใผใซใใฃใฆใฏใใใฎใชใใทใงใณใไฝฟใใๅ ดๅใใใใฐใไฝฟใใชใๅ ดๅใใใใพใใ
+* ใใกใคใณใซ้ข้ฃไปใใใใใใใชใใฏIPใขใใฌในไธใงใ๏ผๅฐใชใใจใ่จผๆๆธๅๅพใใญใปในไธญใฏ๏ผ**ใตใผใใผ**ใจใใฆๅฎ่กใใพใใ
+ * ไธใง่ฟฐในใใใใซใ็นๅฎใฎIPใจใใผใใงใชใในใณใงใใใใญใปในใฏ1ใคใ ใใงใใ
+ * ใใใฏใๅใTLS Termination Proxyใ่จผๆๆธใฎๆดๆฐๅฆ็ใ่กใๅ ดๅใซ้ๅธธใซไพฟๅฉใช็็ฑใฎ1ใคใงใใ
+ * ใใใงใชใใใฐใTLS Termination Proxyใไธๆ็ใซๅๆญขใใ่จผๆๆธใๅๅพใใใใใซๆดๆฐใใญใฐใฉใ ใ่ตทๅใใTLS Termination Proxyใง่จผๆๆธใ่จญๅฎใใTLS Termination Proxyใๅ่ตทๅใใชใใใฐใชใใชใใใใใใพใใใTLS Termination Proxyใๅๆญขใใฆใใ้ใฏใขใใชใๅฉ็จใงใใชใใชใใใใใใใฏ็ๆณ็ใงใฏใใใพใใใ
+
+
+ใขใใชใๆไพใใชใใใใฎใใใชๆดๆฐๅฆ็ใ่กใใใจใฏใใขใใชใฑใผใทใงใณใปใตใผใใผ๏ผUvicornใชใฉ๏ผใงTLS่จผๆๆธใ็ดๆฅไฝฟ็จใใใฎใงใฏใชใใTLS Termination Proxyใไฝฟ็จใใฆ**HTTPSใๅฆ็ใใๅฅใฎใทในใใ **ใ็จๆใใใใชใไธปใช็็ฑใฎ1ใคใงใใ
+
+## ใพใจใ
+
+**HTTPS**ใๆใคใใจใฏ้ๅธธใซ้่ฆใงใใใใปใจใใฉใฎๅ ดๅใใใชใ**ใฏใชใใฃใซใซ**ใงใใ้็บ่
ใจใใฆ HTTPS ใซ้ขใใๅดๅใฎใปใจใใฉใฏใใใใใฎ**ๆฆๅฟตใจใใฎไป็ตใฟใ็่งฃใใ**ใใจใงใใ
+
+ใใใใใฒใจใใณ**้็บ่
ๅใHTTPS**ใฎๅบๆฌ็ใชๆ
ๅ ฑใ็ฅใใฐใ็ฐกๅใชๆนๆณใงใในใฆใ็ฎก็ใใใใใซใใใพใใพใชใใผใซใ็ตใฟๅใใใฆ่จญๅฎใใใใจใใงใใพใใ
+
+ๆฌกใฎ็ซ ใงใฏใ**FastAPI** ใขใใชใฑใผใทใงใณใฎใใใซ **HTTPS** ใใปใใใขใใใใๆนๆณใซใคใใฆใใใใคใใฎๅ
ทไฝไพใ็ดนไปใใพใใ๐
diff --git a/docs/ja/docs/deployment/server-workers.md b/docs/ja/docs/deployment/server-workers.md
new file mode 100644
index 000000000..e1ea165a2
--- /dev/null
+++ b/docs/ja/docs/deployment/server-workers.md
@@ -0,0 +1,182 @@
+# Server Workers - Gunicorn ใจ Uvicorn
+
+ๅๅใฎใใใญใคใกใณใใฎใณใณใปใใใๆฏใ่ฟใฃใฆใฟใพใใใ๏ผ
+
+* ใปใญใฅใชใใฃ - HTTPS
+* ่ตทๅๆใฎๅฎ่ก
+* ๅ่ตทๅ
+* **ใฌใใชใฑใผใทใงใณ๏ผๅฎ่กไธญใฎใใญใปในๆฐ๏ผ**
+* ใกใขใช
+* ้ๅงๅใฎไบๅในใใใ
+
+ใใใพใงใฎใใญใฅใกใณใใฎใใฅใผใใชใขใซใงใฏใใใใใUvicornใฎใใใช**ใตใผใใผใใญใฐใฉใ **ใ**ๅไธใฎใใญใปใน**ใงๅฎ่กใใฆใใพใใ
+
+ใขใใชใฑใผใทใงใณใใใใญใคใใ้ใซใฏใ**่คๆฐใฎใณใข**ใๅฉ็จใใใใใฆใใๅคใใฎใชใฏใจในใใๅฆ็ใงใใใใใซใใใใใซใใใญใปในใฎ**ใฌใใชใฑใผใทใงใณ**ใๆใคใใจใๆใใงใใใใ
+
+ๅใฎใใฃใใฟใผใงใใ[ใใใญใคใกใณใใฎใณใณใปใใ](./concepts.md){.internal-link target=_blank}ใซใฆ่ฆใฆใใใใใซใๆๅนใชๆฆ็ฅใใใใคใใใใพใใ
+
+ใใใงใฏ**Gunicorn**ใ**Uvicornใฎใฏใผใซใผใปใใญใปใน**ใ็ฎก็ใใๅ ดๅใฎไฝฟใๆนใซใคใใฆ็ดนไปใใฆใใใพใใ
+
+!!! info
+
+ DockerใKubernetesใชใฉใฎใณใณใใใไฝฟ็จใใฆใใๅ ดๅใฏใๆฌกใฎ็ซ ใง่ฉณใใ่ชฌๆใใพใ๏ผ [ใณใณใใๅ
ใฎFastAPI - Docker](./docker.md){.internal-link target=_blank}
+
+ ็นใซ**Kubernetes**ไธใงๅฎ่กใใๅ ดๅใฏใใใใใ**Gunicornใไฝฟ็จใใ**ใ**ใณใณใใใใจใซๅไธใฎUvicornใใญใปใน**ใๅฎ่กใใใใจใซใชใใพใใใใใใซใคใใฆใฏใใฎ็ซ ใฎๅพๅใง่ชฌๆใใพใใ
+
+## GunicornใซใใUvicornใฎใฏใผใซใผใปใใญใปในใฎ็ฎก็
+
+**Gunicorn**ใฏ**WSGIๆจๆบ**ใฎใขใใชใฑใผใทใงใณใตใผใใผใงใใใใฎใใจใฏใGunicornใฏFlaskใDjangoใฎใใใชใขใใชใฑใผใทใงใณใซใตใผใในใๆไพใงใใใใจใๆๅณใใพใใGunicornใใ่ชไฝใฏ**FastAPI**ใจไบๆๆงใใชใใงใใใใจใใใฎใFastAPIใฏๆๆฐใฎ**ASGI ๆจๆบ**ใไฝฟ็จใใฆใใใใใงใใ
+
+ใใใใGunicornใฏ**ใใญใปในใใใผใธใฃใผ**ใจใใฆๅไฝใใใฆใผใถใผใ็นๅฎใฎ**ใฏใผใซใผใปใใญใปในใฏใฉใน**ใไฝฟ็จใใใใใซๆ็คบใใใใจใใงใใพใใใใใจGunicornใฏใใฎใฏใฉในใไฝฟใ1ใคไปฅไธใฎ**ใฏใผใซใผใปใใญใปใน**ใ้ๅงใใพใใ
+
+ใใใฆ**Uvicorn**ใซใฏ**Gunicornไบๆใฎใฏใผใซใผใฏใฉใน**ใใใใพใใ
+
+ใใฎ็ตใฟๅใใใงใGunicornใฏ**ใใญใปในใใใผใธใฃใผ**ใจใใฆๅไฝใใ**ใใผใ**ใจ**IP**ใใชใในใณใใพใใใใใฆใ**Uvicornใฏใฉใน**ใๅฎ่กใใฆใใใฏใผใซใผใปใใญใปในใซ้ไฟกใ**่ปข้**ใใพใใ
+
+ใใใฆใGunicornไบๆใฎ**Uvicornใฏใผใซใผ**ใฏใฉในใใFastAPIใไฝฟใใใใใซใGunicornใใ้ใใใฆใใใใผใฟใASGIๆจๆบใซๅคๆใใๅฝนๅฒใๆ
ใใพใใ
+
+## GunicornใจUvicornใใคใณในใใผใซใใ
+
+
-
-## Permitir acesso pรบblico
-
-Por padrรฃo, a Deta lidarรก com a autenticaรงรฃo usando cookies para sua conta.
-
-Mas quando estiver pronto, vocรช pode tornรก-lo pรบblico com:
-
-
-
-## Saiba mais
-
-Em algum momento, vocรช provavelmente desejarรก armazenar alguns dados para seu aplicativo de uma forma que persista ao longo do tempo. Para isso vocรช pode usar Deta Base, que tambรฉm tem um generoso **nรญvel gratuito**.
-
-Vocรช tambรฉm pode ler mais na documentaรงรฃo da Deta.
-
-## Conceitos de implantaรงรฃo
-
-Voltando aos conceitos que discutimos em [Deployments Concepts](./concepts.md){.internal-link target=_blank}, veja como cada um deles seria tratado com a Deta:
-
-* **HTTPS**: Realizado pela Deta, eles fornecerรฃo um subdomรญnio e lidarรฃo com HTTPS automaticamente.
-* **Executando na inicializaรงรฃo**: Realizado pela Deta, como parte de seu serviรงo.
-* **Reinicializaรงรฃo**: Realizado pela Deta, como parte de seu serviรงo.
-* **Replicaรงรฃo**: Realizado pela Deta, como parte de seu serviรงo.
-* **Memรณria**: Limite predefinido pela Deta, vocรช pode contatรก-los para aumentรก-lo.
-* **Etapas anteriores a inicializaรงรฃo**: Nรฃo suportado diretamente, vocรช pode fazรช-lo funcionar com o sistema Cron ou scripts adicionais.
-
-!!! note "Nota"
- O Deta foi projetado para facilitar (e gratuitamente) a implantaรงรฃo rรกpida de aplicativos simples.
-
- Ele pode simplificar vรกrios casos de uso, mas, ao mesmo tempo, nรฃo suporta outros, como o uso de bancos de dados externos (alรฉm do prรณprio sistema de banco de dados NoSQL da Deta), mรกquinas virtuais personalizadas, etc.
-
- Vocรช pode ler mais detalhes na documentaรงรฃo da Deta para ver se รฉ a escolha certa para vocรช.
diff --git a/docs/pt/docs/external-links.md b/docs/pt/docs/external-links.md
index 6ec6c3a27..77ec32351 100644
--- a/docs/pt/docs/external-links.md
+++ b/docs/pt/docs/external-links.md
@@ -9,70 +9,21 @@ Aqui tem uma lista, incompleta, de algumas delas.
!!! tip "Dica"
Se vocรช tem um artigo, projeto, ferramenta ou qualquer coisa relacionada ao **FastAPI** que ainda nรฃo estรก listada aqui, crie um _Pull Request_ adicionando ele.
-## Artigos
+{% for section_name, section_content in external_links.items() %}
-### Inglรชs
+## {{ section_name }}
-{% if external_links %}
-{% for article in external_links.articles.english %}
+{% for lang_name, lang_content in section_content.items() %}
+
+### {{ lang_name }}
+
+{% for item in lang_content %}
+
+* {{ item.title }} by {{ item.author }}.
-* {{ article.title }} by {{ article.author }}.
{% endfor %}
-{% endif %}
-
-### Japonรชs
-
-{% if external_links %}
-{% for article in external_links.articles.japanese %}
-
-* {{ article.title }} by {{ article.author }}.
{% endfor %}
-{% endif %}
-
-### Vietnamita
-
-{% if external_links %}
-{% for article in external_links.articles.vietnamese %}
-
-* {{ article.title }} by {{ article.author }}.
{% endfor %}
-{% endif %}
-
-### Russo
-
-{% if external_links %}
-{% for article in external_links.articles.russian %}
-
-* {{ article.title }} by {{ article.author }}.
-{% endfor %}
-{% endif %}
-
-### Alemรฃo
-
-{% if external_links %}
-{% for article in external_links.articles.german %}
-
-* {{ article.title }} by {{ article.author }}.
-{% endfor %}
-{% endif %}
-
-## Podcasts
-
-{% if external_links %}
-{% for article in external_links.podcasts.english %}
-
-* {{ article.title }} by {{ article.author }}.
-{% endfor %}
-{% endif %}
-
-## Palestras
-
-{% if external_links %}
-{% for article in external_links.talks.english %}
-
-* {{ article.title }} by {{ article.author }}.
-{% endfor %}
-{% endif %}
## Projetos
diff --git a/docs/pt/docs/features.md b/docs/pt/docs/features.md
index bd0db8e76..822992c5b 100644
--- a/docs/pt/docs/features.md
+++ b/docs/pt/docs/features.md
@@ -25,7 +25,7 @@ Documentaรงรฃo interativa da API e navegaรงรฃo _web_ da interface de usuรกrio. C
### Apenas Python moderno
-Tudo รฉ baseado no padrรฃo das declaraรงรตes de **tipos do Python 3.6** (graรงas ao Pydantic). Nenhuma sintaxe nova para aprender. Apenas o padrรฃo moderno do Python.
+Tudo รฉ baseado no padrรฃo das declaraรงรตes de **tipos do Python 3.8** (graรงas ao Pydantic). Nenhuma sintaxe nova para aprender. Apenas o padrรฃo moderno do Python.
Se vocรช precisa refrescar a memรณria rapidamente sobre como usar tipos do Python (mesmo que vocรช nรฃo use o FastAPI), confira esse rรกpido tutorial: [Tipos do Python](python-types.md){.internal-link target=_blank}.
diff --git a/docs/pt/docs/help-fastapi.md b/docs/pt/docs/help-fastapi.md
index d82ce3414..d04905197 100644
--- a/docs/pt/docs/help-fastapi.md
+++ b/docs/pt/docs/help-fastapi.md
@@ -114,8 +114,6 @@ do FastAPI.
Use o chat apenas para outro tipo de assunto.
-Tambรฉm existe o chat do Gitter, porรฉm ele nรฃo possuรญ canais e recursos avanรงados, conversas sรฃo mais engessadas, por isso o Discord รฉ mais recomendado.
-
### Nรฃo faรงa perguntas no chat
Tenha em mente que os chats permitem uma "conversa mais livre", dessa forma รฉ muito fรกcil fazer perguntas que sรฃo muito genรฉricas e dificeรญs de responder, assim vocรช pode acabar nรฃo sendo respondido.
diff --git a/docs/pt/docs/index.md b/docs/pt/docs/index.md
index 591e7f3d4..d1e64b3b9 100644
--- a/docs/pt/docs/index.md
+++ b/docs/pt/docs/index.md
@@ -24,7 +24,7 @@
---
-FastAPI รฉ um moderno e rรกpido (alta performance) _framework web_ para construรงรฃo de APIs com Python 3.6 ou superior, baseado nos _type hints_ padrรตes do Python.
+FastAPI รฉ um moderno e rรกpido (alta performance) _framework web_ para construรงรฃo de APIs com Python 3.8 ou superior, baseado nos _type hints_ padrรตes do Python.
Os recursos chave sรฃo:
@@ -100,7 +100,7 @@ Se vocรช estiver construindo uma aplicaรงรฃo ../../../docs_src/body_multiple_params/tutorial001.py!}
@@ -44,7 +44,7 @@ Mas vocรช pode tambรฉm declarar mรบltiplos parรขmetros de corpo, por exemplo, `i
{!> ../../../docs_src/body_multiple_params/tutorial002_py310.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="22"
{!> ../../../docs_src/body_multiple_params/tutorial002.py!}
@@ -87,7 +87,7 @@ Se vocรช declarรก-lo como รฉ, porque รฉ um valor singular, o **FastAPI** assumir
Mas vocรช pode instruir o **FastAPI** para tratรก-lo como outra chave do corpo usando `Body`:
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="22"
{!> ../../../docs_src/body_multiple_params/tutorial003.py!}
@@ -143,7 +143,7 @@ Por exemplo:
{!> ../../../docs_src/body_multiple_params/tutorial004_py310.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="27"
{!> ../../../docs_src/body_multiple_params/tutorial004.py!}
@@ -172,7 +172,7 @@ como em:
{!> ../../../docs_src/body_multiple_params/tutorial005_py310.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="17"
{!> ../../../docs_src/body_multiple_params/tutorial005.py!}
diff --git a/docs/pt/docs/tutorial/encoder.md b/docs/pt/docs/tutorial/encoder.md
index bb4483fdc..b9bfbf63b 100644
--- a/docs/pt/docs/tutorial/encoder.md
+++ b/docs/pt/docs/tutorial/encoder.md
@@ -26,7 +26,7 @@ A funรงรฃo recebe um objeto, como um modelo Pydantic e retorna uma versรฃo compa
{!> ../../../docs_src/encoder/tutorial001_py310.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="5 22"
{!> ../../../docs_src/encoder/tutorial001.py!}
diff --git a/docs/pt/docs/tutorial/extra-models.md b/docs/pt/docs/tutorial/extra-models.md
index dd5407eb2..1343a3ae4 100644
--- a/docs/pt/docs/tutorial/extra-models.md
+++ b/docs/pt/docs/tutorial/extra-models.md
@@ -17,7 +17,7 @@ Isso รฉ especialmente o caso para modelos de usuรกrios, porque:
Aqui estรก uma ideia geral de como os modelos poderiam parecer com seus campos de senha e os lugares onde sรฃo usados:
-=== "Python 3.6 and above"
+=== "Python 3.8 and above"
```Python hl_lines="9 11 16 22 24 29-30 33-35 40-41"
{!> ../../../docs_src/extra_models/tutorial001.py!}
@@ -158,7 +158,7 @@ Toda conversรฃo de dados, validaรงรฃo, documentaรงรฃo, etc. ainda funcionarรก no
Dessa forma, podemos declarar apenas as diferenรงas entre os modelos (com `password` em texto claro, com `hashed_password` e sem senha):
-=== "Python 3.6 and above"
+=== "Python 3.8 and above"
```Python hl_lines="9 15-16 19-20 23-24"
{!> ../../../docs_src/extra_models/tutorial002.py!}
@@ -181,7 +181,7 @@ Para fazer isso, use a dica de tipo padrรฃo do Python `Union`, inclua o tipo mais especรญfico primeiro, seguido pelo tipo menos especรญfico. No exemplo abaixo, o tipo mais especรญfico `PlaneItem` vem antes de `CarItem` em `Union[PlaneItem, CarItem]`.
-=== "Python 3.6 and above"
+=== "Python 3.8 and above"
```Python hl_lines="1 14-15 18-20 33"
{!> ../../../docs_src/extra_models/tutorial003.py!}
@@ -213,7 +213,7 @@ Da mesma forma, vocรช pode declarar respostas de listas de objetos.
Para isso, use o padrรฃo Python `typing.List` (ou simplesmente `list` no Python 3.9 e superior):
-=== "Python 3.6 and above"
+=== "Python 3.8 and above"
```Python hl_lines="1 20"
{!> ../../../docs_src/extra_models/tutorial004.py!}
@@ -233,7 +233,7 @@ Isso รฉ รบtil se vocรช nรฃo souber os nomes de campo / atributo vรกlidos (que se
Neste caso, vocรช pode usar `typing.Dict` (ou simplesmente dict no Python 3.9 e superior):
-=== "Python 3.6 and above"
+=== "Python 3.8 and above"
```Python hl_lines="1 8"
{!> ../../../docs_src/extra_models/tutorial005.py!}
diff --git a/docs/pt/docs/tutorial/header-params.md b/docs/pt/docs/tutorial/header-params.md
index bc8843327..4bdfb7e9c 100644
--- a/docs/pt/docs/tutorial/header-params.md
+++ b/docs/pt/docs/tutorial/header-params.md
@@ -12,7 +12,7 @@ Primeiro importe `Header`:
{!> ../../../docs_src/header_params/tutorial001_py310.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="3"
{!> ../../../docs_src/header_params/tutorial001.py!}
@@ -30,7 +30,7 @@ O primeiro valor รฉ o valor padrรฃo, vocรช pode passar todas as validaรงรตes adi
{!> ../../../docs_src/header_params/tutorial001_py310.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="9"
{!> ../../../docs_src/header_params/tutorial001.py!}
@@ -66,7 +66,7 @@ Se por algum motivo vocรช precisar desabilitar a conversรฃo automรกtica de subli
{!> ../../../docs_src/header_params/tutorial002_py310.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="10"
{!> ../../../docs_src/header_params/tutorial002.py!}
@@ -97,7 +97,7 @@ Por exemplo, para declarar um cabeรงalho de `X-Token` que pode aparecer mais de
{!> ../../../docs_src/header_params/tutorial003_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="9"
{!> ../../../docs_src/header_params/tutorial003.py!}
diff --git a/docs/pt/docs/tutorial/path-operation-configuration.md b/docs/pt/docs/tutorial/path-operation-configuration.md
index e0a23f665..13a87240f 100644
--- a/docs/pt/docs/tutorial/path-operation-configuration.md
+++ b/docs/pt/docs/tutorial/path-operation-configuration.md
@@ -13,7 +13,7 @@ Vocรช pode passar diretamente o cรณdigo `int`, como `404`.
Mas se vocรช nรฃo se lembrar o que cada cรณdigo numรฉrico significa, pode usar as constantes de atalho em `status`:
-=== "Python 3.6 and above"
+=== "Python 3.8 and above"
```Python hl_lines="3 17"
{!> ../../../docs_src/path_operation_configuration/tutorial001.py!}
@@ -42,7 +42,7 @@ Esse cรณdigo de status serรก usado na resposta e serรก adicionado ao esquema Ope
Vocรช pode adicionar tags para sua *operaรงรฃo de rota*, passe o parรขmetro `tags` com uma `list` de `str` (comumente apenas um `str`):
-=== "Python 3.6 and above"
+=== "Python 3.8 and above"
```Python hl_lines="17 22 27"
{!> ../../../docs_src/path_operation_configuration/tutorial002.py!}
@@ -80,7 +80,7 @@ Nestes casos, pode fazer sentido armazenar as tags em um `Enum`.
Vocรช pode adicionar um `summary` e uma `description`:
-=== "Python 3.6 and above"
+=== "Python 3.8 and above"
```Python hl_lines="20-21"
{!> ../../../docs_src/path_operation_configuration/tutorial003.py!}
@@ -104,7 +104,7 @@ Como as descriรงรตes tendem a ser longas e cobrir vรกrias linhas, vocรช pode dec
Vocรช pode escrever Markdown na docstring, ele serรก interpretado e exibido corretamente (levando em conta a indentaรงรฃo da docstring).
-=== "Python 3.6 and above"
+=== "Python 3.8 and above"
```Python hl_lines="19-27"
{!> ../../../docs_src/path_operation_configuration/tutorial004.py!}
@@ -131,7 +131,7 @@ Ela serรก usada nas documentaรงรตes interativas:
Vocรช pode especificar a descriรงรฃo da resposta com o parรขmetro `response_description`:
-=== "Python 3.6 and above"
+=== "Python 3.8 and above"
```Python hl_lines="21"
{!> ../../../docs_src/path_operation_configuration/tutorial005.py!}
diff --git a/docs/pt/docs/tutorial/path-params-numeric-validations.md b/docs/pt/docs/tutorial/path-params-numeric-validations.md
index ec9b74b30..eb0d31dc3 100644
--- a/docs/pt/docs/tutorial/path-params-numeric-validations.md
+++ b/docs/pt/docs/tutorial/path-params-numeric-validations.md
@@ -12,7 +12,7 @@ Primeiro, importe `Path` de `fastapi`:
{!> ../../../docs_src/path_params_numeric_validations/tutorial001_py310.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="3"
{!> ../../../docs_src/path_params_numeric_validations/tutorial001.py!}
@@ -30,7 +30,7 @@ Por exemplo para declarar um valor de metadado `title` para o parรขmetro de rota
{!> ../../../docs_src/path_params_numeric_validations/tutorial001_py310.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="10"
{!> ../../../docs_src/path_params_numeric_validations/tutorial001.py!}
diff --git a/docs/pt/docs/tutorial/path-params.md b/docs/pt/docs/tutorial/path-params.md
index 5de3756ed..cd8c18858 100644
--- a/docs/pt/docs/tutorial/path-params.md
+++ b/docs/pt/docs/tutorial/path-params.md
@@ -236,7 +236,6 @@ Entรฃo, vocรช poderia usar ele com:
Com o **FastAPI**, usando as declaraรงรตes de tipo do Python, vocรช obtรฉm:
* Suporte no editor: verificaรงรฃo de erros, e opรงรฃo de autocompletar, etc.
-* Parsing de dados
* "Parsing" de dados
* Validaรงรฃo de dados
* Anotaรงรฃo da API e documentaรงรฃo automรกtica
diff --git a/docs/pt/docs/tutorial/query-params.md b/docs/pt/docs/tutorial/query-params.md
index 3ada4fd21..08bb99dbc 100644
--- a/docs/pt/docs/tutorial/query-params.md
+++ b/docs/pt/docs/tutorial/query-params.md
@@ -69,7 +69,7 @@ Da mesma forma, vocรช pode declarar parรขmetros de consulta opcionais, definindo
{!> ../../../docs_src/query_params/tutorial002_py310.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="9"
{!> ../../../docs_src/query_params/tutorial002.py!}
@@ -91,7 +91,7 @@ Vocรช tambรฉm pode declarar tipos `bool`, e eles serรฃo convertidos:
{!> ../../../docs_src/query_params/tutorial003_py310.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="9"
{!> ../../../docs_src/query_params/tutorial003.py!}
@@ -143,7 +143,7 @@ Eles serรฃo detectados pelo nome:
{!> ../../../docs_src/query_params/tutorial004_py310.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="8 10"
{!> ../../../docs_src/query_params/tutorial004.py!}
@@ -209,7 +209,7 @@ E claro, vocรช pode definir alguns parรขmetros como obrigatรณrios, alguns possui
{!> ../../../docs_src/query_params/tutorial006_py310.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="10"
{!> ../../../docs_src/query_params/tutorial006.py!}
diff --git a/docs/ru/docs/deployment/docker.md b/docs/ru/docs/deployment/docker.md
new file mode 100644
index 000000000..f045ca944
--- /dev/null
+++ b/docs/ru/docs/deployment/docker.md
@@ -0,0 +1,700 @@
+# FastAPI ะธ Docker-ะบะพะฝัะตะนะฝะตัั
+
+ะัะธ ัะฐะทะฒััััะฒะฐะฝะธะธ ะฟัะธะปะพะถะตะฝะธะน FastAPI, ัะฐััะพ ะฝะฐัะธะฝะฐัั ั ัะพะทะดะฐะฝะธั **ะพะฑัะฐะทะฐ ะบะพะฝัะตะนะฝะตัะฐ ะฝะฐ ะพัะฝะพะฒะต Linux**. ะะฑััะฝะพ ะดะปั ััะพะณะพ ะธัะฟะพะปัะทััั **Docker**. ะะฐัะตะผ ะผะพะถะฝะพ ัะฐะทะฒะตัะฝััั ัะฐะบะพะน ะบะพะฝัะตะนะฝะตั ะฝะฐ ัะตัะฒะตัะต ะพะดะฝะธะผ ะธะท ะฝะตัะบะพะปัะบะธั
ัะฟะพัะพะฑะพะฒ.
+
+ะัะฟะพะปัะทะพะฒะฐะฝะธะต ะบะพะฝัะตะนะฝะตัะพะฒ ะฝะฐ ะพัะฝะพะฒะต Linux ะธะผะตะตั ััะด ะฟัะตะธะผััะตััะฒ, ะฒะบะปััะฐั **ะฑะตะทะพะฟะฐัะฝะพััั**, **ะฒะพัะฟัะพะธะทะฒะพะดะธะผะพััั**, **ะฟัะพััะพัั** ะธ ะฟัะพัะธะต.
+
+!!! tip "ะะพะดัะบะฐะทะบะฐ"
+ ะขะพัะพะฟะธัะตัั ะธะปะธ ัะถะต ะทะฝะฐะบะพะผั ั ััะพะน ัะตั
ะฝะพะปะพะณะธะตะน? ะะตัะตะฟััะณะฝะธัะต ะฝะฐ ัะฐะทะดะตะป [ะกะพะทะดะฐัั Docker-ะพะฑัะฐะท ะดะปั FastAPI ๐](#docker-fastapi)
+
+
+
+### ะะพะดะฐะนัะต ัะธะฟะธ
+
+ะะฐะฒะฐะนัะต ะทะผัะฝะธะผะพ ะพะดะธะฝ ััะดะพะบ ะท ะฟะพะฟะตัะตะดะฝัะพั ะฒะตัััั.
+
+ะะธ ะทะผัะฝะธะผะพ ัะฐะผะต ัะตะน ััะฐะณะผะตะฝั, ะฟะฐัะฐะผะตััะธ ััะฝะบััั, ะท:
+
+```Python
+ first_name, last_name
+```
+
+ะฝะฐ:
+
+```Python
+ first_name: str, last_name: str
+```
+
+ะัั ั ะฒัะต.
+
+ะฆะต "type hints":
+
+```Python hl_lines="1"
+{!../../../docs_src/python_types/tutorial002.py!}
+```
+
+ะฆะต ะฝะต ัะต ัะฐะผะต, ัะพ ะพะณะพะปะพัะตะฝะฝั ะทะฝะฐัะตะฝั ะทะฐ ะทะฐะผะพะฒััะฒะฐะฝะฝัะผ, ัะบ ัะต ะฑัะปะพ ะฑ ะท:
+
+```Python
+ first_name="john", last_name="doe"
+```
+
+ะฆะต ะทะพะฒััะผ ัะฝัะต.
+
+ะะธ ะฒะธะบะพัะธััะพะฒััะผะพ ะดะฒะพะบัะฐะฟะบั (`:`), ะฝะต ะดะพััะฒะฝัั (`=`).
+
+ะ ะดะพะดะฐะฒะฐะฝะฝั ะฐะฝะพัะฐััั ัะธะฟั ะทะฐะทะฒะธัะฐะน ะฝะต ะทะผัะฝัั ัะพะณะพ, ัะพ ััะฐะปะพัั ะฑะธ ะฑะตะท ะฝะธั
.
+
+ะะปะต ัะตะฟะตั, ััะฒััั ัะพ ะฒะธ ะฟะพัะตัะตะด ะฟัะพัะตัั ััะฒะพัะตะฝะฝั ััะฝะบััั, ะฐะปะต ะท ะฐะฝะพัะฐัััะผะธ ัะธะฟัะฒ.
+
+ะ ัะตะน ะถะต ะผะพะผะตะฝั, ะฒะธ ัะฟัะพะฑัััะต ะฒะธะบะปะธะบะฐัะธ ะฐะฒัะพะทะฐะฟะพะฒะฝะตะฝะฝั ะท ะดะพะฟะพะผะพะณะพั `Ctrl+Space` ั ะฟะพะฑะฐัะธัะต:
+
+
+
+ะ ะฐะทะพะผ ะท ัะธะผ, ะฒะธ ะผะพะถะตัะต ะฟัะพะบััััะฒะฐัะธ, ะฟะตัะตะณะปัะดะฐัะธ ะพะฟััั, ะดะพะฟะพะบะธ ะฒะธ ะฝะต ะทะฝะฐะนะดะตัะต ะพะดะฝั, ัะพ ะทะฒััะธัั ัั
ะพะถะต:
+
+
+
+## ะัะปััะต ะผะพัะธะฒะฐััั
+
+ะะตัะตะฒัััะต ัั ััะฝะบััั, ะฒะพะฝะฐ ะฒะถะต ะผะฐั ะฐะฝะพัะฐััั ัะธะฟั:
+
+```Python hl_lines="1"
+{!../../../docs_src/python_types/tutorial003.py!}
+```
+
+ะัะบัะปัะบะธ ัะตะดะฐะบัะพั ะทะฝะฐั ัะธะฟะธ ะทะผัะฝะฝะธั
, ะฒะธ ะฝะต ััะปัะบะธ ะพััะธะผะฐััะต ะฐะฒัะพะทะฐะฟะพะฒะฝะตะฝะฝั, ะฒะธ ัะฐะบะพะถ ะพััะธะผะฐััะต ะฟะตัะตะฒััะบั ะฟะพะผะธะปะพะบ:
+
+
+
+ะขะตะฟะตั ะฒะธ ะทะฝะฐััะต, ัะพะฑ ะฒะธะฟัะฐะฒะธัะธ ัะต, ะฒะฐะผ ะฟะพัััะฑะฝะพ ะฟะตัะตัะฒะพัะธัะธ `age` ั ัััะพะบั ะท ะดะพะฟะพะผะพะณะพั `str(age)`:
+
+```Python hl_lines="2"
+{!../../../docs_src/python_types/tutorial004.py!}
+```
+
+## ะะณะพะปะพัะตะฝะฝั ัะธะฟัะฒ
+
+ะฉะพะนะฝะพ ะฒะธ ะฟะพะฑะฐัะธะปะธ ะพัะฝะพะฒะฝะต ะผัััะต ะดะปั ะพะณะพะปะพัะตะฝะฝั ะฐะฝะพัะฐััะน ัะธะฟั. ะฏะบ ะฟะฐัะฐะผะตััะธ ััะฝะบััั.
+
+ะฆะต ัะฐะบะพะถ ะพัะฝะพะฒะฝะต ะผัััะต, ะดะต ะฒะธ ะฑ ัั
ะฒะธะบะพัะธััะพะฒัะฒะฐะปะธ ั **FastAPI**.
+
+### ะัะพััั ัะธะฟะธ
+
+ะะธ ะผะพะถะตัะต ะพะณะพะปะพััะฒะฐัะธ ััั ััะฐะฝะดะฐััะฝั ัะธะฟะธ ั Python, ะฝะต ััะปัะบะธ `str`.
+
+ะะธ ะผะพะถะตัะต ะฒะธะบะพัะธััะพะฒัะฒะฐัะธ, ะฝะฐะฟัะธะบะปะฐะด:
+
+* `int`
+* `float`
+* `bool`
+* `bytes`
+
+```Python hl_lines="1"
+{!../../../docs_src/python_types/tutorial005.py!}
+```
+
+### Generic-ัะธะฟะธ ะท ะฟะฐัะฐะผะตััะฐะผะธ ัะธะฟัะฒ
+
+ะัะฝัััั ะดะตัะบั ััััะบัััะธ ะดะฐะฝะธั
, ัะบั ะผะพะถััั ะผัััะธัะธ ัะฝัั ะทะฝะฐัะตะฝะฝั, ะฝะฐะฟัะธะบะปะฐะด `dict`, `list`, `set` ัะฐ `tuple`. ะ ะฒะฝัััััะฝั ะทะฝะฐัะตะฝะฝั ัะฐะบะพะถ ะผะพะถััั ะผะฐัะธ ัะฒัะน ัะธะฟ.
+
+ะฆั ัะธะฟะธ, ัะบั ะผะฐััั ะฒะฝัััััะฝั ัะธะฟะธ, ะฝะฐะทะธะฒะฐััััั "**generic**" ัะธะฟะฐะผะธ. ะ ะพะณะพะปะพัะธัะธ ัั
ะผะพะถะฝะฐ ะฝะฐะฒััั ัะท ะฒะฝัััััะฝัะผะธ ัะธะฟะฐะผะธ.
+
+ะฉะพะฑ ะพะณะพะปะพัะธัะธ ัั ัะธะฟะธ ัะฐ ะฒะฝัััััะฝั ัะธะฟะธ, ะฒะธ ะผะพะถะตัะต ะฒะธะบะพัะธััะพะฒัะฒะฐัะธ ััะฐะฝะดะฐััะฝะธะน ะผะพะดัะปั Python `typing`. ะัะฝ ััะฝัั ัะฟะตััะฐะปัะฝะพ ะดะปั ะฟัะดััะธะผะบะธ ะฐะฝะพัะฐััะน ัะธะฟัะฒ.
+
+#### ะะพะฒััั ะฒะตัััั Python
+
+ะกะธะฝัะฐะบัะธั ัะท ะฒะธะบะพัะธััะฐะฝะฝัะผ `typing` **ััะผััะฝะธะน** ะท ัััะผะฐ ะฒะตััััะผะธ, ะฒัะด Python 3.6 ะดะพ ะพััะฐะฝะฝัั
, ะฒะบะปััะฐััะธ Python 3.9, Python 3.10 ัะพัะพ.
+
+ะฃ ะผััั ัะพะทะฒะธัะบั Python **ะฝะพะฒััั ะฒะตัััั** ะผะฐััั ะฟะพะบัะฐัะตะฝั ะฟัะดััะธะผะบั ะฐะฝะพัะฐััะน ัะธะฟัะฒ ั ะฒ ะฑะฐะณะฐััะพั
ะฒะธะฟะฐะดะบะฐั
ะฒะฐะผ ะฝะฐะฒััั ะฝะต ะฟะพัััะฑะฝะพ ะฑัะดะต ัะผะฟะพัััะฒะฐัะธ ัะฐ ะฒะธะบะพัะธััะพะฒัะฒะฐัะธ ะผะพะดัะปั `typing` ะดะปั ะพะณะพะปะพัะตะฝะฝั ะฐะฝะพัะฐััะน ัะธะฟั.
+
+ะฏะบัะพ ะฒะธ ะผะพะถะตัะต ะฒะธะฑัะฐัะธ ะฝะพะฒััั ะฒะตัััั Python ะดะปั ัะฒะพะณะพ ะฟัะพะตะบัั, ะฒะธ ะทะผะพะถะตัะต ัะบะพัะธััะฐัะธัั ัััั ะดะพะดะฐัะบะพะฒะพั ะฟัะพััะพัะพั. ะะธะฒััััั ะบัะปัะบะฐ ะฟัะธะบะปะฐะดัะฒ ะฝะธะถัะต.
+
+#### List (ัะฟะธัะพะบ)
+
+ะะฐะฟัะธะบะปะฐะด, ะดะฐะฒะฐะนัะต ะฒะธะทะฝะฐัะธะผะพ ะทะผัะฝะฝั, ัะบะฐ ะฑัะดะต `list` ัะท `str`.
+
+=== "Python 3.8 ั ะฒะธัะต"
+
+ ะ ะผะพะดัะปั `typing`, ัะผะฟะพััััะผะพ `List` (ะท ะฒะตะปะธะบะพั ะปััะตัะธ `L`):
+
+ ``` Python hl_lines="1"
+ {!> ../../../docs_src/python_types/tutorial006.py!}
+ ```
+
+ ะะณะพะปะพัะธะผะพ ะทะผัะฝะฝั ะท ัะธะผ ัะฐะผะธะผ ัะธะฝัะฐะบัะธัะพะผ ะดะฒะพะบัะฐะฟะบะธ (`:`).
+
+ ะฏะบ ัะธะฟ ะฒะบะฐะถะตะผะพ `List`, ัะบะธะน ะฒะธ ัะผะฟะพัััะฒะฐะปะธ ะท `typing`.
+
+ ะัะบัะปัะบะธ ัะฟะธัะพะบ ั ัะธะฟะพะผ, ัะบะธะน ะผัััะธัั ะดะตัะบั ะฒะฝัััััะฝั ัะธะฟะธ, ะฒะธ ะฟะพะผััะฐััะต ัั
ั ะบะฒะฐะดัะฐัะฝั ะดัะถะบะธ:
+
+ ```Python hl_lines="4"
+ {!> ../../../docs_src/python_types/tutorial006.py!}
+ ```
+
+=== "Python 3.9 ั ะฒะธัะต"
+
+ ะะณะพะปะพัะธะผะพ ะทะผัะฝะฝั ะท ัะธะผ ัะฐะผะธะผ ัะธะฝัะฐะบัะธัะพะผ ะดะฒะพะบัะฐะฟะบะธ (`:`).
+
+ ะฏะบ ัะธะฟ ะฒะบะฐะถะตะผะพ `list`.
+
+ ะัะบัะปัะบะธ ัะฟะธัะพะบ ั ัะธะฟะพะผ, ัะบะธะน ะผัััะธัั ะดะตัะบั ะฒะฝัััััะฝั ัะธะฟะธ, ะฒะธ ะฟะพะผััะฐััะต ัั
ั ะบะฒะฐะดัะฐัะฝั ะดัะถะบะธ:
+
+ ```Python hl_lines="1"
+ {!> ../../../docs_src/python_types/tutorial006_py39.py!}
+ ```
+
+!!! info
+ ะฆั ะฒะฝัััััะฝั ัะธะฟะธ ะฒ ะบะฒะฐะดัะฐัะฝะธั
ะดัะถะบะฐั
ะฝะฐะทะธะฒะฐััััั "ะฟะฐัะฐะผะตััะฐะผะธ ัะธะฟั".
+
+ ะฃ ััะพะผั ะฒะธะฟะฐะดะบั, `str` ัะต ะฟะฐัะฐะผะตัั ัะธะฟั ะฟะตัะตะดะฐะฝะธะน ั `List` (ะฐะฑะพ `list` ั Python 3.9 ั ะฒะธัะต).
+
+ะฆะต ะพะทะฝะฐัะฐั: "ะทะผัะฝะฝะฐ `items` ัะต `list`, ั ะบะพะถะตะฝ ะท ะตะปะตะผะตะฝััะฒ ั ััะพะผั ัะฟะธัะบั - `str`".
+
+!!! tip
+ ะฏะบัะพ ะฒะธ ะฒะธะบะพัะธััะพะฒัััะต Python 3.9 ั ะฒะธัะต, ะฒะฐะผ ะฝะต ะฟะพัััะฑะฝะพ ัะผะฟะพัััะฒะฐัะธ `List` ะท `typing`, ะฒะธ ะผะพะถะตัะต ะฒะธะบะพัะธััะพะฒัะฒะฐัะธ ะฝะฐัะพะผัััั ัะธะฟ `list`.
+
+ะัะพะฑะธะฒัะธ ัะต, ะฒะฐั ัะตะดะฐะบัะพั ะผะพะถะต ะฝะฐะดะฐัะธ ะฟัะดััะธะผะบั ะฝะฐะฒััั ะฟัะด ัะฐั ะพะฑัะพะฑะบะธ ะตะปะตะผะตะฝััะฒ ะทั ัะฟะธัะบั:
+
+
+
+ะะตะท ัะธะฟัะฒ ััะพะณะพ ะผะฐะนะถะต ะฝะตะผะพะถะปะธะฒะพ ะดะพััะณัะธ.
+
+ะะฒะตัะฝััั ัะฒะฐะณั, ัะพ ะทะผัะฝะฝะฐ `item` ั ะพะดะฝะธะผ ัะท ะตะปะตะผะตะฝััะฒ ั ัะฟะธัะบั `items`.
+
+ะ ะฒัะต ะถ ัะตะดะฐะบัะพั ะทะฝะฐั, ัะพ ัะต `str`, ั ะฝะฐะดะฐั ะฟัะดััะธะผะบั ะดะปั ััะพะณะพ.
+
+#### Tuple and Set (ะบะพััะตะถ ัะฐ ะฝะฐะฑัั)
+
+ะะธ ะฟะพะฒะธะฝะฝั ะทัะพะฑะธัะธ ัะต ะถ ัะฐะผะต, ัะพะฑ ะพะณะพะปะพัะธัะธ `tuple` ั `set`:
+
+=== "Python 3.8 ั ะฒะธัะต"
+
+ ```Python hl_lines="1 4"
+ {!> ../../../docs_src/python_types/tutorial007.py!}
+ ```
+
+=== "Python 3.9 ั ะฒะธัะต"
+
+ ```Python hl_lines="1"
+ {!> ../../../docs_src/python_types/tutorial007_py39.py!}
+ ```
+
+ะฆะต ะพะทะฝะฐัะฐั:
+
+* ะะผัะฝะฝะฐ `items_t` ัะต `tuple` ะท 3 ะตะปะตะผะตะฝัะฐะผะธ, `int`, ัะต `int`, ัะฐ `str`.
+* ะะผัะฝะฝะฐ `items_s` ัะต `set`, ั ะบะพะถะตะฝ ะนะพะณะพ ะตะปะตะผะตะฝั ัะธะฟั `bytes`.
+
+#### Dict (ัะปะพะฒะฝะธะบ)
+
+ะฉะพะฑ ะพะณะพะปะพัะธัะธ `dict`, ะฒะฐะผ ะฟะพัััะฑะฝะพ ะฟะตัะตะดะฐัะธ 2 ะฟะฐัะฐะผะตััะธ ัะธะฟั, ัะพะทะดัะปะตะฝั ะบะพะผะฐะผะธ.
+
+ะะตััะธะน ะฟะฐัะฐะผะตัั ัะธะฟั ะดะปั ะบะปััะฐ ั `dict`.
+
+ะััะณะธะน ะฟะฐัะฐะผะตัั ัะธะฟั ะดะปั ะทะฝะฐัะตะฝะฝั ั `dict`:
+
+=== "Python 3.8 ั ะฒะธัะต"
+
+ ```Python hl_lines="1 4"
+ {!> ../../../docs_src/python_types/tutorial008.py!}
+ ```
+
+=== "Python 3.9 ั ะฒะธัะต"
+
+ ```Python hl_lines="1"
+ {!> ../../../docs_src/python_types/tutorial008_py39.py!}
+ ```
+
+ะฆะต ะพะทะฝะฐัะฐั:
+
+* ะะผัะฝะฝะฐ `prices` ัะต `dict`:
+ * ะะปััั ััะพะณะพ `dict` ัะธะฟั `str` (ะฝะฐะฟัะธะบะปะฐะด, ะฝะฐะทะฒะฐ ะบะพะถะฝะพะณะพ ะตะปะตะผะตะฝัั).
+ * ะะฝะฐัะตะฝะฝั ััะพะณะพ `dict` ัะธะฟั `float` (ะฝะฐะฟัะธะบะปะฐะด, ััะฝะฐ ะบะพะถะฝะพะณะพ ะตะปะตะผะตะฝัั).
+
+#### Union (ะพะฑ'ัะดะฝะฐะฝะฝั)
+
+ะะธ ะผะพะถะตัะต ะพะณะพะปะพัะธัะธ, ัะพ ะทะผัะฝะฝะฐ ะผะพะถะต ะฑััะธ ะฑัะดั-ัะบะธะผ ัะท **ะบัะปัะบะพั
ัะธะฟัะฒ**, ะฝะฐะฟัะธะบะปะฐะด, `int` ะฐะฑะพ `str`.
+
+ะฃ Python 3.6 ั ะฒะธัะต (ะฒะบะปััะฐััะธ Python 3.10) ะฒะธ ะผะพะถะตัะต ะฒะธะบะพัะธััะพะฒัะฒะฐัะธ ัะธะฟ `Union` ะท `typing` ั ะฒััะฐะฒะปััะธ ะฒ ะบะฒะฐะดัะฐัะฝั ะดัะถะบะธ ะผะพะถะปะธะฒั ัะธะฟะธ, ัะบั ะผะพะถะฝะฐ ะฟัะธะนะฝััะธ.
+
+ะฃ Python 3.10 ัะฐะบะพะถ ั **ะฐะปััะตัะฝะฐัะธะฒะฝะธะน ัะธะฝัะฐะบัะธั**, ั ัะบะพะผั ะฒะธ ะผะพะถะตัะต ัะพะทะดัะปะธัะธ ะผะพะถะปะธะฒั ัะธะฟะธ ะทะฐ ะดะพะฟะพะผะพะณะพั ะฒะตััะธะบะฐะปัะฝะพั ัะผัะณะธ (`|`).
+
+=== "Python 3.8 ั ะฒะธัะต"
+
+ ```Python hl_lines="1 4"
+ {!> ../../../docs_src/python_types/tutorial008b.py!}
+ ```
+
+=== "Python 3.10 ั ะฒะธัะต"
+
+ ```Python hl_lines="1"
+ {!> ../../../docs_src/python_types/tutorial008b_py310.py!}
+ ```
+
+ะ ะพะฑะพั
ะฒะธะฟะฐะดะบะฐั
ัะต ะพะทะฝะฐัะฐั, ัะพ `item` ะผะพะถะต ะฑััะธ `int` ะฐะฑะพ `str`.
+
+#### Possibly `None` (Optional)
+
+ะะธ ะผะพะถะตัะต ะพะณะพะปะพัะธัะธ, ัะพ ะทะฝะฐัะตะฝะฝั ะผะพะถะต ะผะฐัะธ ัะธะฟ, ะฝะฐะฟัะธะบะปะฐะด `str`, ะฐะปะต ัะฐะบะพะถ ะผะพะถะต ะฑััะธ `None`.
+
+ะฃ Python 3.6 ั ะฒะธัะต (ะฒะบะปััะฐััะธ Python 3.10) ะฒะธ ะผะพะถะตัะต ะพะณะพะปะพัะธัะธ ะนะพะณะพ, ัะผะฟะพัััะฒะฐะฒัะธ ัะฐ ะฒะธะบะพัะธััะพะฒัััะธ `Optional` ะท ะผะพะดัะปั `typing`.
+
+```Python hl_lines="1 4"
+{!../../../docs_src/python_types/tutorial009.py!}
+```
+
+ะะธะบะพัะธััะฐะฝะฝั `Optional[str]` ะทะฐะผัััั ะฟัะพััะพ `str` ะดะพะทะฒะพะปะธัั ัะตะดะฐะบัะพัั ะดะพะฟะพะผะพะณัะธ ะฒะฐะผ ะฒะธัะฒะธัะธ ะฟะพะผะธะปะบะธ, ะบะพะปะธ ะฒะธ ะผะพะณะปะธ ะฑ ะฒะฒะฐะถะฐัะธ, ัะพ ะทะฝะฐัะตะฝะฝัะผ ะทะฐะฒะถะดะธ ั `str`, ั
ะพัะฐ ะฝะฐัะฟัะฐะฒะดั ะฒะพะฝะพ ัะฐะบะพะถ ะผะพะถะต ะฑััะธ `None`.
+
+`Optional[Something]` ะฝะฐัะฟัะฐะฒะดั ั ัะบะพัะพัะตะฝะฝัะผ ะดะปั `Union[Something, None]`, ะฒะพะฝะธ ะตะบะฒัะฒะฐะปะตะฝัะฝั.
+
+ะฆะต ัะฐะบะพะถ ะพะทะฝะฐัะฐั, ัะพ ะฒ Python 3.10 ะฒะธ ะผะพะถะตัะต ะฒะธะบะพัะธััะพะฒัะฒะฐัะธ `Something | None`:
+
+=== "Python 3.8 ั ะฒะธัะต"
+
+ ```Python hl_lines="1 4"
+ {!> ../../../docs_src/python_types/tutorial009.py!}
+ ```
+
+=== "Python 3.8 ั ะฒะธัะต - ะฐะปััะตัะฝะฐัะธะฒะฐ"
+
+ ```Python hl_lines="1 4"
+ {!> ../../../docs_src/python_types/tutorial009b.py!}
+ ```
+
+=== "Python 3.10 ั ะฒะธัะต"
+
+ ```Python hl_lines="1"
+ {!> ../../../docs_src/python_types/tutorial009_py310.py!}
+ ```
+
+#### Generic ัะธะฟะธ
+
+ะฆั ัะธะฟะธ, ัะบั ะฟัะธะนะผะฐััั ะฟะฐัะฐะผะตััะธ ัะธะฟั ั ะบะฒะฐะดัะฐัะฝะธั
ะดัะถะบะฐั
, ะฝะฐะทะธะฒะฐััััั **Generic types** or **Generics**, ะฝะฐะฟัะธะบะปะฐะด:
+
+=== "Python 3.8 ั ะฒะธัะต"
+
+ * `List`
+ * `Tuple`
+ * `Set`
+ * `Dict`
+ * `Union`
+ * `Optional`
+ * ...ัะฐ ัะฝัั.
+
+=== "Python 3.9 ั ะฒะธัะต"
+
+ ะะธ ะผะพะถะตัะต ะฒะธะบะพัะธััะพะฒัะฒะฐัะธ ัั ัะฐะผั ะฒะฑัะดะพะฒะฐะฝั ัะธะฟะธ, ัะบ generic (ะท ะบะฒะฐะดัะฐัะฝะธะผะธ ะดัะถะบะฐะผะธ ัะฐ ัะธะฟะฐะผะธ ะฒัะตัะตะดะธะฝั):
+
+ * `list`
+ * `tuple`
+ * `set`
+ * `dict`
+
+ ะ ัะต ัะฐะผะต, ัะพ ะน ั Python 3.8, ัะท ะผะพะดัะปั `typing`:
+
+ * `Union`
+ * `Optional`
+ * ...ัะฐ ัะฝัั.
+
+=== "Python 3.10 ั ะฒะธัะต"
+
+ ะะธ ะผะพะถะตัะต ะฒะธะบะพัะธััะพะฒัะฒะฐัะธ ัั ัะฐะผั ะฒะฑัะดะพะฒะฐะฝั ัะธะฟะธ, ัะบ generic (ะท ะบะฒะฐะดัะฐัะฝะธะผะธ ะดัะถะบะฐะผะธ ัะฐ ัะธะฟะฐะผะธ ะฒัะตัะตะดะธะฝั):
+
+ * `list`
+ * `tuple`
+ * `set`
+ * `dict`
+
+ ะ ัะต ัะฐะผะต, ัะพ ะน ั Python 3.8, ัะท ะผะพะดัะปั `typing`:
+
+ * `Union`
+ * `Optional` (ัะฐะบ ัะฐะผะพ ัะบ ั Python 3.8)
+ * ...ัะฐ ัะฝัั.
+
+ ะฃ Python 3.10, ัะบ ะฐะปััะตัะฝะฐัะธะฒะฐ ะฒะธะบะพัะธััะฐะฝะฝั `Union` ัะฐ `Optional`, ะฒะธ ะผะพะถะตัะต ะฒะธะบะพัะธััะพะฒัะฒะฐัะธ ะฒะตััะธะบะฐะปัะฝั ัะผัะณั (`|`) ัะพะฑ ะพะณะพะปะพัะธัะธ ะพะฑ'ัะดะฝะฐะฝะฝั ัะธะฟัะฒ.
+
+### ะะปะฐัะธ ัะบ ัะธะฟะธ
+
+ะะธ ัะฐะบะพะถ ะผะพะถะตัะต ะพะณะพะปะพัะธัะธ ะบะปะฐั ัะบ ัะธะฟ ะทะผัะฝะฝะพั.
+
+ะกะบะฐะถัะผะพ, ั ะฒะฐั ั ะบะปะฐั `Person` ะท ัะผสผัะผ:
+
+```Python hl_lines="1-3"
+{!../../../docs_src/python_types/tutorial010.py!}
+```
+
+ะะพััะผ ะฒะธ ะผะพะถะตัะต ะพะณะพะปะพัะธัะธ ะทะผัะฝะฝั ัะธะฟั `Person`:
+
+```Python hl_lines="6"
+{!../../../docs_src/python_types/tutorial010.py!}
+```
+
+ะ ะทะฝะพะฒั ะถ ัะฐะบะธ, ะฒะธ ะพััะธะผัััะต ะฒัั ะฟัะดััะธะผะบั ัะตะดะฐะบัะพัะฐ:
+
+
+
+## Pydantic ะผะพะดะตะปั
+
+Pydantic ัะต ะฑัะฑะปัะพัะตะบะฐ Python ะดะปั ะฒะฐะปัะดะฐััั ะดะฐะฝะธั
.
+
+ะะธ ะพะณะพะปะพััััะต ยซัะพัะผัยป ะดะฐะฝะธั
ัะบ ะบะปะฐัะธ ะท ะฐััะธะฑััะฐะผะธ.
+
+ะ ะบะพะถะตะฝ ะฐััะธะฑัั ะผะฐั ัะธะฟ.
+
+ะะพััะผ ะฒะธ ััะฒะพััััะต ะตะบะทะตะผะฟะปัั ััะพะณะพ ะบะปะฐัั ะท ะดะตัะบะธะผะธ ะทะฝะฐัะตะฝะฝัะผะธ, ั ะฒัะฝ ะฟะตัะตะฒััะธัั ัั ะทะฝะฐัะตะฝะฝั, ะฟะตัะตัะฒะพัะธัั ัั
ั ะฒัะดะฟะพะฒัะดะฝะธะน ัะธะฟ (ัะบัะพ ั ะฟะพััะตะฑะฐ) ั ะฝะฐะดะฐััั ะฒะฐะผ ะพะฑโัะบั ะท ัััะผะฐ ะดะฐะฝะธะผะธ.
+
+ะ ะฒะธ ะพััะธะผัััะต ะฒัั ะฟัะดััะธะผะบั ัะตะดะฐะบัะพัะฐ ะท ัะธะผ ะพััะธะผะฐะฝะธะผ ะพะฑโัะบัะพะผ.
+
+ะัะธะบะปะฐะด ะท ะดะพะบัะผะตะฝัะฐััั Pydantic:
+
+=== "Python 3.8 ั ะฒะธัะต"
+
+ ```Python
+ {!> ../../../docs_src/python_types/tutorial011.py!}
+ ```
+
+=== "Python 3.9 ั ะฒะธัะต"
+
+ ```Python
+ {!> ../../../docs_src/python_types/tutorial011_py39.py!}
+ ```
+
+=== "Python 3.10 ั ะฒะธัะต"
+
+ ```Python
+ {!> ../../../docs_src/python_types/tutorial011_py310.py!}
+ ```
+
+!!! info
+ ะฉะพะฑ ะดัะทะฝะฐัะธัั ะฑัะปััะต ะฟัะพ Pydantic, ะฟะตัะตะณะปัะฝััะต ะนะพะณะพ ะดะพะบัะผะตะฝัะฐััั.
+
+**FastAPI** ะฟะพะฒะฝัััั ะฑะฐะทัััััั ะฝะฐ Pydantic.
+
+ะะธ ะฟะพะฑะฐัะธัะต ะฝะฐะฑะฐะณะฐัะพ ะฑัะปััะต ััะพะณะพ ะฒััะพะณะพ ะฝะฐ ะฟัะฐะบัะธัั ะฒ [Tutorial - User Guide](tutorial/index.md){.internal-link target=_blank}.
+
+## ะะฝะพัะฐััั ัะธะฟัะฒ ั **FastAPI**
+
+**FastAPI** ะฒะธะบะพัะธััะพะฒัั ัั ะฟัะดะบะฐะทะบะธ ะดะปั ะฒะธะบะพะฝะฐะฝะฝั ะบัะปัะบะพั
ัะตัะตะน.
+
+ะ **FastAPI** ะฒะธ ะพะณะพะปะพััััะต ะฟะฐัะฐะผะตััะธ ะท ะฟัะดะบะฐะทะบะฐะผะธ ัะธะฟั, ั ะพััะธะผัััะต:
+
+* **ะัะดััะธะผะบั ัะตะดะฐะบัะพัะฐ**.
+* **ะะตัะตะฒััะบั ัะธะฟัะฒ**.
+
+...ั **FastAPI** ะฒะธะบะพัะธััะพะฒัั ัั ัะฐะผั ะพะณะพะปะพัะตะฝะฝั ะดะปั:
+
+* **ะะธะทะฝะฐัะตะฝะฝั ะฒะธะผะพะณ**: ะท ะฟะฐัะฐะผะตัััะฒ ัะปัั
ั ะทะฐะฟะธัั, ะฟะฐัะฐะผะตัััะฒ ะทะฐะฟะธัั, ะทะฐะณะพะปะพะฒะบัะฒ, ััะป, ะทะฐะปะตะถะฝะพััะตะน ัะพัะพ.
+* **ะะตัะตัะฒะพัะตะฝะฝั ะดะฐะฝะธั
**: ัะท ะทะฐะฟะธัั ะฒ ะฝะตะพะฑั
ัะดะฝะธะน ัะธะฟ.
+* **ะะตัะตะฒััะบะฐ ะดะฐะฝะธั
**: ัะพ ะฝะฐะดั
ะพะดััั ะฒัะด ะบะพะถะฝะพะณะพ ะทะฐะฟะธัั:
+ * ะะตะฝะตััะฒะฐะฝะฝั **ะฐะฒัะพะผะฐัะธัะฝะธั
ะฟะพะผะธะปะพะบ**, ัะพ ะฟะพะฒะตััะฐััััั ะบะปััะฝัั, ะบะพะปะธ ะดะฐะฝั ะฝะตะดัะนัะฝั.
+* **ะะพะบัะผะตะฝััะฒะฐะฝะฝั** API ะทะฐ ะดะพะฟะพะผะพะณะพั OpenAPI:
+ * ัะบะธะน ะฟะพััะผ ะฒะธะบะพัะธััะพะฒัััััั ะดะปั ะฐะฒัะพะผะฐัะธัะฝะพั ัะฝัะตัะฐะบัะธะฒะฝะพั ะดะพะบัะผะตะฝัะฐััั ะบะพัะธัััะฒะฐะปัะฝะธััะบะธั
ัะฝัะตััะตะนััะฒ.
+
+ะัะต ัะต ะผะพะถะต ะทะดะฐัะธัั ะฐะฑัััะฐะบัะฝะธะผ. ะะต ั
ะฒะธะปัะนัะตัั. ะะธ ะฟะพะฑะฐัะธัะต ะฒัะต ัะต ะฒ ะดัั ะฒ [ะขััะพััะฐะป - ะะพััะฑะฝะธะบ ะบะพัะธัััะฒะฐัะฐ](tutorial/index.md){.internal-link target=_blank}.
+
+ะะฐะถะปะธะฒะพ ัะต, ัะพ ะทะฐ ะดะพะฟะพะผะพะณะพั ััะฐะฝะดะฐััะฝะธั
ัะธะฟัะฒ Python ะฒ ะพะดะฝะพะผั ะผัััั (ะทะฐะผัััั ัะพะณะพ, ัะพะฑ ะดะพะดะฐะฒะฐัะธ ะฑัะปััะต ะบะปะฐััะฒ, ะดะตะบะพัะฐัะพััะฒ ัะพัะพ), **FastAPI** ะทัะพะฑะธัั ะฑะฐะณะฐัะพ ัะพะฑะพัะธ ะทะฐ ะฒะฐั.
+
+!!! info
+ ะฏะบัะพ ะฒะธ ะฒะถะต ะฟัะพะนัะปะธ ะฒะตัั ะฝะฐะฒัะฐะปัะฝะธะน ะฟะพััะฑะฝะธะบ ั ะฟะพะฒะตัะฝัะปะธัั, ัะพะฑ ะดัะทะฝะฐัะธัั ะฑัะปััะต ะฟัะพ ัะธะฟะธ, ะพัั ั
ะพัะพัะธะน ัะตัััั "ัะฟะฐัะณะฐะปะบะฐ" ะฒัะด `mypy`.
diff --git a/docs/uk/docs/tutorial/body.md b/docs/uk/docs/tutorial/body.md
index e78c5de0e..9759e7f45 100644
--- a/docs/uk/docs/tutorial/body.md
+++ b/docs/uk/docs/tutorial/body.md
@@ -19,7 +19,7 @@
ะกะฟะพัะฐัะบั ะฒะฐะผ ะฟะพัััะฑะฝะพ ัะผะฟะพัััะฒะฐัะธ `BaseModel` ะท `pydantic`:
-=== "Python 3.6 ั ะฒะธัะต"
+=== "Python 3.8 ั ะฒะธัะต"
```Python hl_lines="4"
{!> ../../../docs_src/body/tutorial001.py!}
@@ -37,7 +37,7 @@
ะะธะบะพัะธััะพะฒัะนัะต ััะฐะฝะดะฐััะฝั ัะธะฟะธ Python ะดะปั ะฒััั
ะฐััะธะฑัััะฒ:
-=== "Python 3.6 ั ะฒะธัะต"
+=== "Python 3.8 ั ะฒะธัะต"
```Python hl_lines="7-11"
{!> ../../../docs_src/body/tutorial001.py!}
@@ -75,7 +75,7 @@
ะฉะพะฑ ะดะพะดะฐัะธ ะผะพะดะตะปั ะดะฐะฝะธั
ะดะพ ะฒะฐัะพั *ะพะฟะตัะฐััั ัะปัั
ั*, ะพะณะพะปะพัััั ัั ัะฐะบ ัะฐะผะพ, ัะบ ะฒะธ ะพะณะพะปะพัะธะปะธ ะฟะฐัะฐะผะตััะธ ัะปัั
ั ัะฐ ะทะฐะฟะธัั:
-=== "Python 3.6 ั ะฒะธัะต"
+=== "Python 3.8 ั ะฒะธัะต"
```Python hl_lines="18"
{!> ../../../docs_src/body/tutorial001.py!}
@@ -149,7 +149,7 @@
ะฃัะตัะตะดะธะฝั ััะฝะบััั ะฒะธ ะผะพะถะตัะต ะพััะธะผะฐัะธ ะฟััะผะธะน ะดะพัััะฟ ะดะพ ะฒััั
ะฐััะธะฑัััะฒ ะพะฑโัะบัะฐ ะผะพะดะตะปั:
-=== "Python 3.6 ั ะฒะธัะต"
+=== "Python 3.8 ั ะฒะธัะต"
```Python hl_lines="21"
{!> ../../../docs_src/body/tutorial002.py!}
@@ -167,7 +167,7 @@
**FastAPI** ัะพะทะฟัะทะฝะฐั, ัะพ ะฟะฐัะฐะผะตััะธ ััะฝะบััั, ัะบั ะฒัะดะฟะพะฒัะดะฐััั ะฟะฐัะฐะผะตััะฐะผ ัะปัั
ั, ะผะฐััั ะฑััะธ **ะฒะทััั ะท ัะปัั
ั**, ะฐ ะฟะฐัะฐะผะตััะธ ััะฝะบััั, ัะบั ะพะณะพะปะพััััััั ัะบ ะผะพะดะตะปั Pydantic, **ะฒะทััั ะท ััะปะฐ ะทะฐะฟะธัั**.
-=== "Python 3.6 ั ะฒะธัะต"
+=== "Python 3.8 ั ะฒะธัะต"
```Python hl_lines="17-18"
{!> ../../../docs_src/body/tutorial003.py!}
@@ -185,7 +185,7 @@
**FastAPI** ัะพะทะฟัะทะฝะฐั ะบะพะถะตะฝ ะท ะฝะธั
ั ะฒัะทัะผะต ะดะฐะฝั ะท ะฟะพัััะฑะฝะพะณะพ ะผัััั.
-=== "Python 3.6 ั ะฒะธัะต"
+=== "Python 3.8 ั ะฒะธัะต"
```Python hl_lines="18"
{!> ../../../docs_src/body/tutorial004.py!}
diff --git a/docs/uk/docs/tutorial/cookie-params.md b/docs/uk/docs/tutorial/cookie-params.md
new file mode 100644
index 000000000..199b93839
--- /dev/null
+++ b/docs/uk/docs/tutorial/cookie-params.md
@@ -0,0 +1,96 @@
+# ะะฐัะฐะผะตััะธ Cookie
+
+ะะธ ะผะพะถะตัะต ะฒะธะทะฝะฐัะธัะธ ะฟะฐัะฐะผะตััะธ 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`
+
+ะะพััะผ ะฒะธะทะฝะฐััะต ะฟะฐัะฐะผะตััะธ cookie, ะฒะธะบะพัะธััะพะฒัััะธ ัะฐะบั ะถ ะบะพะฝััััะบััั ัะบ ะดะปั `Path` ั `Query`.
+
+ะะตััะต ะทะฝะฐัะตะฝะฝั ัะต ะทะฝะฐัะตะฝะฝั ะทะฐ ะทะฐะผะพะฒััะฒะฐะฝะฝัะผ, ะฒะธ ะผะพะถะตัะต ัะฐะบะพะถ ะฟะตัะตะดะฐัะธ ะฒัั ะดะพะดะฐัะบะพะฒั ะฟะฐัะฐะผะตััะธ ะฒะฐะปัะดะฐััั ัะธ ะฐะฝะพัะฐััั:
+
+=== "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!}
+ ```
+
+!!! note "ะขะตั
ะฝััะฝั ะะตัะฐะปั"
+ `Cookie` ัะต "ัะตัััะฐ" ะบะปะฐััะฒ `Path` ั `Query`. ะะพะฝะธ ะฝะฐัะปัะดัััััั ะฒัะด ะพะดะฝะพะณะพ ะฑะฐััะบัะฒััะบะพะณะพ ะบะปะฐัั `Param`.
+ ะะปะต ะฟะฐะผ'ััะฐะนัะต, ัะพ ะบะพะปะธ ะฒะธ ัะผะฟะพัััััะต `Query`, `Path`, `Cookie` ัะฐ ัะฝัะต ะท `fastapi`, ัะต ัะฐะบัะธัะฝะพ ััะฝะบััั, ัะพ ะฟะพะฒะตััะฐััั ัะฟะตััะฐะปัะฝั ะบะปะฐัะธ.
+
+!!! info
+ ะะปั ะฒะธะทะฝะฐัะตะฝะฝั cookies ะฒะธ ะผะฐััะต ะฒะธะบะพัะธััะพะฒัะฒะฐัะธ `Cookie`, ัะพะผั ัะพ ะฒ ัะฝัะพะผั ะฒะธะฟะฐะดะบั ะฟะฐัะฐะผะตััะธ ะฑัะดััั ัะฝัะตัะฟัะธัะพะฒะฐะฝั, ัะบ ะฟะฐัะฐะผะตััะธ ะทะฐะฟะธัั.
+
+## ะัะดััะผะบะธ
+
+ะะธะทะฝะฐัะฐะนัะต cookies ะทะฐ ะดะพะฟะพะผะพะณะพั `Cookie`, ะฒะธะบะพัะธััะพะฒัััะธ ัะพะน ะถะต ัะฟัะปัะฝะธะน ัะฐะฑะปะพะฝ, ัะพ ั `Query` ัะฐ `Path`.
diff --git a/docs/uk/docs/tutorial/encoder.md b/docs/uk/docs/tutorial/encoder.md
new file mode 100644
index 000000000..b6583341f
--- /dev/null
+++ b/docs/uk/docs/tutorial/encoder.md
@@ -0,0 +1,42 @@
+# JSON Compatible Encoder
+
+ะัะฝัััั ะฒะธะฟะฐะดะบะธ, ะบะพะปะธ ะฒะฐะผ ะผะพะถะต ะทะฝะฐะดะพะฑะธัะธัั ะฟะตัะตัะฒะพัะธัะธ ัะธะฟ ะดะฐะฝะธั
(ะฝะฐะฟัะธะบะปะฐะด, ะผะพะดะตะปั Pydantic) ะฒ ัะพัั ััะผััะฝะต ะท JSON (ะฝะฐะฟัะธะบะปะฐะด, `dict`, `list`, ั ั. ะด.).
+
+ะะฐะฟัะธะบะปะฐะด, ัะบัะพ ะฒะฐะผ ะฟะพัััะฑะฝะพ ะทะฑะตัะตะณัะธ ัะต ะฒ ะฑะฐะทั ะดะฐะฝะธั
.
+
+ะะปั ััะพะณะพ, **FastAPI** ะฝะฐะดะฐั `jsonable_encoder()` ััะฝะบััั.
+
+## ะะธะบะพัะธััะฐะฝะฝั `jsonable_encoder`
+
+ะะฐะฒะฐะนัะต ััะฒะธะผะพ, ัะพ ั ะฒะฐั ั ะฑะฐะทะฐ ะดะฐะฝะธั
`fake_db`, ัะบะฐ ะฟัะธะนะผะฐั ะปะธัะต ะดะฐะฝั, ััะผััะฝั ะท JSON.
+
+ะะฐะฟัะธะบะปะฐะด, ะฒะพะฝะฐ ะฝะต ะฟัะธะนะผะฐั ะพะฑ'ัะบัะธ ัะธะฟั `datetime`, ะพัะบัะปัะบะธ ะฒะพะฝะธ ะฝะต ััะผััะฝั ะท JSON.
+
+ะัะถะต, ะพะฑ'ัะบั ัะธะฟั `datetime` ะฟะพัััะฑะฝะพ ะฟะตัะตัะฒะพัะธัะธ ะฒ ััะดะพะบ `str`, ัะบะธะน ะผัััะธัั ะดะฐะฝั ะฒ ISO ัะพัะผะฐัั.
+
+ะขะธะผ ัะฐะผะธะผ ัะฟะพัะพะฑะพะผ ัั ะฑะฐะทะฐ ะดะฐะฝะธั
ะฝะต ะฟัะธะนะผะฐัะธะผะต ะพะฑ'ัะบั ัะธะฟั Pydantic model (ะพะฑ'ัะบั ะท ะฐััะธะฑััะฐะผะธ), ะฐ ะปะธัะต `dict`.
+
+ะะธ ะผะพะถะตัะต ะฒะธะบะพัะธััะพะฒัะฒะฐัะธ `jsonable_encoder` ะดะปั ััะพะณะพ.
+
+ะะพะฝะฐ ะฟัะธะนะผะฐั ะพะฑ'ัะบั, ัะฐะบะธะน ัะบ Pydantic model, ั ะฟะพะฒะตััะฐั ะนะพะณะพ ะฒะตัััั, ััะผััะฝั ะท JSON:
+
+=== "Python 3.10+"
+
+ ```Python hl_lines="4 21"
+ {!> ../../../docs_src/encoder/tutorial001_py310.py!}
+ ```
+
+=== "Python 3.8+"
+
+ ```Python hl_lines="5 22"
+ {!> ../../../docs_src/encoder/tutorial001.py!}
+ ```
+
+ะฃ ััะพะผั ะฟัะธะบะปะฐะดั ะฒะพะฝะฐ ะบะพะฝะฒะตัััั Pydantic model ั `dict`, ะฐ `datetime` ั `str`.
+
+ะ ะตะทัะปััะฐั ะฒะธะบะปะธะบั ัััั ััะฝะบััั - ัะต ัะพัั, ัะพ ะผะพะถะฝะฐ ะบะพะดัะฒะฐัะธ ะท ะฒะธะบะพัะธััะฐะฝะฝัะผ ััะฐะฝะดะฐััั Python `json.dumps()`.
+
+ะะพะฝะฐ ะฝะต ะฟะพะฒะตััะฐั ะฒะตะปะธะบั ัััะพะบั `str`, ัะบะฐ ะผัััะธัั ะดะฐะฝั ั ัะพัะผะฐัั JSON (ัะบ ัััะพะบะฐ). ะะพะฝะฐ ะฟะพะฒะตััะฐั ััะฐะฝะดะฐััะฝั ััััะบัััั ะดะฐะฝะธั
Python (ะฝะฐะฟัะธะบะปะฐะด `dict`) ัะท ะทะฝะฐัะตะฝะฝัะผะธ ัะฐ ะฟัะดะทะฝะฐัะตะฝะฝัะผะธ, ัะบั ั ััะผััะฝะธะผะธ ะท JSON.
+
+!!! ะัะธะผััะบะฐ
+ `jsonable_encoder` ัะฐะบัะธัะฝะพ ะฒะธะบะพัะธััะพะฒัััััั **FastAPI** ะฒะฝัััััะฝัะพ ะดะปั ะฟะตัะตัะฒะพัะตะฝะฝั ะดะฐะฝะธั
. ะัะพัะต ะฒะพะฝะฐ ะบะพัะธัะฝะฐ ะฒ ะฑะฐะณะฐััะพั
ัะฝัะธั
ััะตะฝะฐัััั
.
diff --git a/docs/uk/docs/tutorial/extra-data-types.md b/docs/uk/docs/tutorial/extra-data-types.md
new file mode 100644
index 000000000..ec5ec0d18
--- /dev/null
+++ b/docs/uk/docs/tutorial/extra-data-types.md
@@ -0,0 +1,130 @@
+# ะะพะดะฐัะบะพะฒั ัะธะฟะธ ะดะฐะฝะธั
+
+ะะพ ััะพะณะพ ัะฐัั, ะฒะธ ะฒะธะบะพัะธััะพะฒัะฒะฐะปะธ ะทะฐะณะฐะปัะฝะพะฟะพัะธัะตะฝั ัะธะฟะธ ะดะฐะฝะธั
, ัะฐะบั ัะบ:
+
+* `int`
+* `float`
+* `str`
+* `bool`
+
+ะะปะต ะผะพะถะฝะฐ ัะฐะบะพะถ ะฒะธะบะพัะธััะพะฒัะฒะฐัะธ ะฑัะปัั ัะบะปะฐะดะฝั ัะธะฟะธ ะดะฐะฝะธั
.
+
+ะ ะฒะธ ะฒัะต ัะต ะผะฐัะธะผะตัะต ัั ะถ ะผะพะถะปะธะฒะพััั, ัะบั ะฑัะปะธ ะฟะพะบะฐะทะฐะฝั ะดะพ ััะพะณะพ:
+
+* ะงัะดะพะฒะฐ ะฟัะดััะธะผะบะฐ ัะตะดะฐะบัะพัะฐ.
+* ะะพะฝะฒะตััะฐััั ะดะฐะฝะธั
ะท ะฒั
ัะดะฝะธั
ะทะฐะฟะธััะฒ.
+* ะะพะฝะฒะตััะฐััั ะดะฐะฝะธั
ะดะปั ะฒัะดะฟะพะฒัะดั.
+* ะะฐะปัะดะฐััั ะดะฐะฝะธั
.
+* ะะฒัะพะผะฐัะธัะฝะฐ ะฐะฝะพัะฐััั ัะฐ ะดะพะบัะผะตะฝัะฐััั.
+
+## ะะฝัั ัะธะฟะธ ะดะฐะฝะธั
+
+ะัั ะดะพะดะฐัะบะพะฒั ัะธะฟะธ ะดะฐะฝะธั
ะดะปั ะฒะธะบะพัะธััะฐะฝะฝั:
+
+* `UUID`:
+ * ะกัะฐะฝะดะฐััะฝะธะน "ะฃะฝัะฒะตััะฐะปัะฝะธะน ะฃะฝัะบะฐะปัะฝะธะน ะะดะตะฝัะธััะบะฐัะพั", ัะบะธะน ัะฐััะพ ะฒะธะบะพัะธััะพะฒัััััั ัะบ ัะดะตะฝัะธััะบะฐัะพั ั ะฑะฐะณะฐััะพั
ะฑะฐะทะฐั
ะดะฐะฝะธั
ัะฐ ัะธััะตะผะฐั
.
+ * ะฃ ะทะฐะฟะธัะฐั
ัะฐ ะฒัะดะฟะพะฒัะดัั
ะฑัะดะต ะฟัะตะดััะฐะฒะปะตะฝะธะน ัะบ `str`.
+* `datetime.datetime`:
+ * ะะฐะนัะพะฝัะฒััะบะธะน `datetime.datetime`.
+ * ะฃ ะทะฐะฟะธัะฐั
ัะฐ ะฒัะดะฟะพะฒัะดัั
ะฑัะดะต ะฟัะตะดััะฐะฒะปะตะฝะธะน ัะบ `str` ะฒ ัะพัะผะฐัั ISO 8601, ัะบ: `2008-09-15T15:53:00+05:00`.
+* `datetime.date`:
+ * ะะฐะนัะพะฝัะฒััะบะธะน `datetime.date`.
+ * ะฃ ะทะฐะฟะธัะฐั
ัะฐ ะฒัะดะฟะพะฒัะดัั
ะฑัะดะต ะฟัะตะดััะฐะฒะปะตะฝะธะน ัะบ `str` ะฒ ัะพัะผะฐัั ISO 8601, ัะบ: `2008-09-15`.
+* `datetime.time`:
+ * ะะฐะนัะพะฝัะฒััะบะธะน `datetime.time`.
+ * ะฃ ะทะฐะฟะธัะฐั
ัะฐ ะฒัะดะฟะพะฒัะดัั
ะฑัะดะต ะฟัะตะดััะฐะฒะปะตะฝะธะน ัะบ `str` ะฒ ัะพัะผะฐัั ISO 8601, ัะบ: `14:23:55.003`.
+* `datetime.timedelta`:
+ * ะะฐะนัะพะฝัะฒััะบะธะน `datetime.timedelta`.
+ * ะฃ ะทะฐะฟะธัะฐั
ัะฐ ะฒัะดะฟะพะฒัะดัั
ะฑัะดะต ะฟัะตะดััะฐะฒะปะตะฝะธะน ัะบ `float` ะทะฐะณะฐะปัะฝะพั ะบัะปัะบะพััั ัะตะบัะฝะด.
+ * Pydantic ัะฐะบะพะถ ะดะพะทะฒะพะปัั ะฟัะตะดััะฐะฒะปััะธ ัะต ัะบ "ISO 8601 time diff encoding", ะฑัะปััะต ัะฝัะพัะผะฐััั ะดะธะฒะธัั ั ะดะพะบัะผะตะฝัะฐััั.
+* `frozenset`:
+ * ะฃ ะทะฐะฟะธัะฐั
ั ะฒัะดะฟะพะฒัะดัั
ัะต ะฑัะดะต ะพะฑัะพะฑะปะตะฝะพ ัะฐะบ ัะฐะผะพ, ัะบ ั `set`:
+ * ะฃ ะทะฐะฟะธัะฐั
ัะฟะธัะพะบ ะฑัะดะต ะทัะธัะฐะฝะพ, ะดัะฑะปัะบะฐัะธ ะฑัะดััั ะฒะธะดะฐะปะตะฝั ัะฐ ะฒัะฝ ะฑัะดะต ะฟะตัะตัะฒะพัะตะฝะธะน ะฝะฐ `set`.
+ * ะฃ ะฒัะดะฟะพะฒัะดัั
, `set` ะฑัะดะต ะฟะตัะตัะฒะพัะตะฝะธะน ะฝะฐ `list`.
+ * ะะณะตะฝะตัะพะฒะฐะฝะฐ ัั
ะตะผะฐ ะฑัะดะต ะฒะบะฐะทัะฒะฐัะธ, ัะพ ะทะฝะฐัะตะฝะฝั `set` ั ัะฝัะบะฐะปัะฝะธะผะธ (ะท ะฒะธะบะพัะธััะฐะฝะฝัะผ JSON Schema's `uniqueItems`).
+* `bytes`:
+ * ะกัะฐะฝะดะฐััะฝะธะน ะะฐะนัะพะฝัะฒััะบะธะน `bytes`.
+ * ะฃ ะทะฐะฟะธัะฐั
ั ะฒัะดะฟะพะฒัะดัั
ัะต ะฑัะดะต ะพะฑัะพะฑะปะตะฝะพ ัะบ `str`.
+ * ะะณะตะฝะตัะพะฒะฐะฝะฐ ัั
ะตะผะฐ ะฑัะดะต ะฒะบะฐะทัะฒะฐัะธ, ัะพ ัะต `str` ะท "ัะพัะผะฐัะพะผ" `binary`.
+* `Decimal`:
+ * ะกัะฐะฝะดะฐััะฝะธะน ะะฐะนัะพะฝัะฒััะบะธะน `Decimal`.
+ * ะฃ ะทะฐะฟะธัะฐั
ั ะฒัะดะฟะพะฒัะดัั
ัะต ะฑัะดะต ะพะฑัะพะฑะปะตะฝะพ ัะฐะบ ัะฐะผะพ, ัะบ ั `float`.
+* ะะธ ะผะพะถะตัะต ะฟะตัะตะฒััะธัะธ ะฒัั ะดัะนัะฝั ัะธะฟะธ ะดะฐะฝะธั
Pydantic ััั: ัะธะฟะธ ะดะฐะฝะธั
Pydantic.
+
+## ะัะธะบะปะฐะด
+
+ะัั ะฟัะธะบะปะฐะด *path operation* ะท ะฟะฐัะฐะผะตััะฐะผะธ, ะฒะธะบะพัะธััะพะฒัััะธ ะดะตัะบั ะท ะฒะธัะตะทะฐะทะฝะฐัะตะฝะธั
ัะธะฟัะฒ.
+
+=== "Python 3.10+"
+
+ ```Python hl_lines="1 3 12-16"
+ {!> ../../../docs_src/extra_data_types/tutorial001_an_py310.py!}
+ ```
+
+=== "Python 3.9+"
+
+ ```Python hl_lines="1 3 12-16"
+ {!> ../../../docs_src/extra_data_types/tutorial001_an_py39.py!}
+ ```
+
+=== "Python 3.8+"
+
+ ```Python hl_lines="1 3 13-17"
+ {!> ../../../docs_src/extra_data_types/tutorial001_an.py!}
+ ```
+
+=== "Python 3.10+ non-Annotated"
+
+ !!! tip
+ ะะฐะถะฐะฝะพ ะฒะธะบะพัะธััะพะฒัะฒะฐัะธ `Annotated` ะฒะตัััั, ัะบัะพ ัะต ะผะพะถะปะธะฒะพ.
+
+ ```Python hl_lines="1 2 11-15"
+ {!> ../../../docs_src/extra_data_types/tutorial001_py310.py!}
+ ```
+
+=== "Python 3.8+ non-Annotated"
+
+ !!! tip
+ ะะฐะถะฐะฝะพ ะฒะธะบะพัะธััะพะฒัะฒะฐัะธ `Annotated` ะฒะตัััั, ัะบัะพ ัะต ะผะพะถะปะธะฒะพ.
+
+ ```Python hl_lines="1 2 12-16"
+ {!> ../../../docs_src/extra_data_types/tutorial001.py!}
+ ```
+
+ะะฒะตัะฝััั ัะฒะฐะณั, ัะพ ะฟะฐัะฐะผะตััะธ ะฒัะตัะตะดะธะฝั ััะฝะบััั ะผะฐััั ัะฒัะน ะทะฒะธัะฐะนะฝะธะน ัะธะฟ ะดะฐะฝะธั
, ั ะฒะธ ะผะพะถะตัะต, ะฝะฐะฟัะธะบะปะฐะด, ะฒะธะบะพะฝัะฒะฐัะธ ะทะฒะธัะฐะนะฝั ะผะฐะฝัะฟัะปัััั ะท ะดะฐัะฐะผะธ, ัะฐะบั ัะบ:
+
+=== "Python 3.10+"
+
+ ```Python hl_lines="18-19"
+ {!> ../../../docs_src/extra_data_types/tutorial001_an_py310.py!}
+ ```
+
+=== "Python 3.9+"
+
+ ```Python hl_lines="18-19"
+ {!> ../../../docs_src/extra_data_types/tutorial001_an_py39.py!}
+ ```
+
+=== "Python 3.8+"
+
+ ```Python hl_lines="19-20"
+ {!> ../../../docs_src/extra_data_types/tutorial001_an.py!}
+ ```
+
+=== "Python 3.10+ non-Annotated"
+
+ !!! tip
+ ะะฐะถะฐะฝะพ ะฒะธะบะพัะธััะพะฒัะฒะฐัะธ `Annotated` ะฒะตัััั, ัะบัะพ ัะต ะผะพะถะปะธะฒะพ.
+
+ ```Python hl_lines="17-18"
+ {!> ../../../docs_src/extra_data_types/tutorial001_py310.py!}
+ ```
+
+=== "Python 3.8+ non-Annotated"
+
+ !!! tip
+ ะะฐะถะฐะฝะพ ะฒะธะบะพัะธััะพะฒัะฒะฐัะธ `Annotated` ะฒะตัััั, ัะบัะพ ัะต ะผะพะถะปะธะฒะพ.
+
+ ```Python hl_lines="18-19"
+ {!> ../../../docs_src/extra_data_types/tutorial001.py!}
+ ```
diff --git a/docs/uk/docs/tutorial/index.md b/docs/uk/docs/tutorial/index.md
new file mode 100644
index 000000000..e5bae74bc
--- /dev/null
+++ b/docs/uk/docs/tutorial/index.md
@@ -0,0 +1,80 @@
+# ะขััะพััะฐะป - ะะพััะฑะฝะธะบ ะบะพัะธัััะฒะฐัะฐ
+
+ะฃ ััะพะผั ะฟะพััะฑะฝะธะบั ะฟะพะบะฐะทะฐะฝะพ, ัะบ ะบะพัะธัััะฒะฐัะธัั **FastAPI** ะท ะฑัะปัััััั ะนะพะณะพ ััะฝะบััะน, ะบัะพะบ ะทะฐ ะบัะพะบะพะผ.
+
+ะะพะถะตะฝ ัะพะทะดัะป ะฟะพัััะฟะพะฒะพ ะฝะฐะดะฑัะดะพะฒัััััั ะฝะฐ ะฟะพะฟะตัะตะดะฝั, ะฐะปะต ะฒัะฝ ััััะบัััะพะฒะฐะฝะธะน ะฝะฐ ะพะบัะตะผั ัะตะผะธ, ัะพะฑ ะฒะธ ะผะพะณะปะธ ะฟะตัะตะนัะธ ะฑะตะทะฟะพัะตัะตะดะฝัะพ ะดะพ ะฑัะดั-ัะบะพั ะบะพะฝะบัะตัะฝะพั, ัะพะฑ ะฒะธัััะธัะธ ะฒะฐัั ะบะพะฝะบัะตัะฝั ะฟะพััะตะฑะธ API.
+
+ะัะฝ ัะฐะบะพะถ ััะฒะพัะตะฝะธะน ัะบ ะดะพะฒัะดะฝะธะบ ะดะปั ัะพะฑะพัะธ ั ะผะฐะนะฑััะฝัะพะผั.
+
+ะขะพะถ ะฒะธ ะผะพะถะตัะต ะฟะพะฒะตัะฝััะธัั ั ะฟะพะฑะฐัะธัะธ ัะฐะผะต ัะต, ัะพ ะฒะฐะผ ะฟะพัััะฑะฝะพ.
+
+## ะะฐะฟัััััั ะบะพะด
+
+ะฃัั ะฑะปะพะบะธ ะบะพะดั ะผะพะถะฝะฐ ัะบะพะฟััะฒะฐัะธ ัะฐ ะฒะธะบะพัะธััะพะฒัะฒะฐัะธ ะฑะตะทะฟะพัะตัะตะดะฝัะพ (ัะต ัะฐะบัะธัะฝะพ ะฟะตัะตะฒััะตะฝั ัะฐะนะปะธ Python).
+
+ะฉะพะฑ ะทะฐะฟัััะธัะธ ะฑัะดั-ัะบะธะน ัะท ะฟัะธะบะปะฐะดัะฒ, ัะบะพะฟััะนัะต ะบะพะด ั ัะฐะนะป `main.py` ั ะทะฐะฟัััััั `uvicorn` ะทะฐ ะดะพะฟะพะผะพะณะพั:
+
+
+
+### Thรชm kiแปu dแปฏ liแปu
+
+Hรฃy sแปญa mแปt dรฒng tแปซ phiรชn bแบฃn trฦฐแปc.
+
+Chรบng ta sแบฝ thay ฤแปi chรญnh xรกc ฤoแบกn nร y, tham sแป cแปงa hร m, tแปซ:
+
+```Python
+ first_name, last_name
+```
+
+sang:
+
+```Python
+ first_name: str, last_name: str
+```
+
+Chรญnh lร nรณ.
+
+Nhแปฏng thแปฉ ฤรณ lร "type hints":
+
+```Python hl_lines="1"
+{!../../../docs_src/python_types/tutorial002.py!}
+```
+
+ฤรณ khรดng giแปng nhฦฐ khai bรกo nhแปฏng giรก trแป mแบทc ฤแปnh giแปng nhฦฐ:
+
+```Python
+ first_name="john", last_name="doe"
+```
+
+Nรณ lร mแปt thแปฉ khรกc.
+
+Chรบng ta sแปญ dแปฅng dแบฅu hai chแบฅm (`:`), khรดng phแบฃi dแบฅu bแบฑng (`=`).
+
+Vร viแปc thรชm gแปฃi รฝ kiแปu dแปฏ liแปu khรดng lร m thay ฤแปi nhแปฏng gรฌ xแบฃy ra so vแปi khi chฦฐa thรชm chรบng.
+
+But now, imagine you are again in the middle of creating that function, but with type hints.
+
+Tแบกi cรนng mแปt ฤiแปm, bแบกn thแปญ kรญch hoแบกt autocomplete vแปi `Ctrl+Space` vร bแบกn thแบฅy:
+
+
+
+Vแปi cรกi ฤรณ, bแบกn cรณ thแป cuแปn, nhรฌn thแบฅy cรกc lแปฑa chแปn, cho ฤแบฟn khi bแบกn tรฌm thแบฅy mแปt "tiแบฟng chuรดng":
+
+
+
+## ฤแปng lแปฑc nhiแปu hฦกn
+
+Kiแปm tra hร m nร y, nรณ ฤรฃ cรณ gแปฃi รฝ kiแปu dแปฏ liแปu:
+
+```Python hl_lines="1"
+{!../../../docs_src/python_types/tutorial003.py!}
+```
+
+Bแปi vรฌ trรฌnh soแบกn thแบฃo biแบฟt kiแปu dแปฏ liแปu cแปงa cรกc biแบฟn, bแบกn khรดng chแป cรณ ฤฦฐแปฃc completion, bแบกn cลฉng ฤฦฐแปฃc kiแปm tra lแปi:
+
+
+
+Bรขy giแป bแบกn biแบฟt rแบฑng bแบกn phแบฃi sแปญa nรณ, chuyแปn `age` sang mแปt xรขu vแปi `str(age)`:
+
+```Python hl_lines="2"
+{!../../../docs_src/python_types/tutorial004.py!}
+```
+
+## Khai bรกo cรกc kiแปu dแปฏ liแปu
+
+Bแบกn mแปi chแป nhรฌn thแบฅy nhแปฏng nฦกi chแปง yแบฟu ฤแป ฤแบทt khai bรกo kiแปu dแปฏ liแปu. Nhฦฐ lร cรกc tham sแป cแปงa hร m.
+
+ฤรขy cลฉng lร nฦกi chแปง yแบฟu ฤแป bแบกn sแปญ dแปฅng chรบng vแปi **FastAPI**.
+
+### Kiแปu dแปฏ liแปu ฤฦกn giแบฃn
+
+Bแบกn cรณ thแป khai bรกo tแบฅt cแบฃ cรกc kiแปu dแปฏ liแปu chuแบฉn cแปงa Python, khรดng chแป lร `str`.
+
+Bแบกn cรณ thแป sแปญ dแปฅng, vรญ dแปฅ:
+
+* `int`
+* `float`
+* `bool`
+* `bytes`
+
+```Python hl_lines="1"
+{!../../../docs_src/python_types/tutorial005.py!}
+```
+
+### Cรกc kiแปu dแปฏ liแปu tแปng quรกt vแปi tham sแป kiแปu dแปฏ liแปu
+
+Cรณ mแปt vร i cแบฅu trรบc dแปฏ liแปu cรณ thแป chแปฉa cรกc giรก trแป khรกc nhau nhฦฐ `dict`, `list`, `set` vร `tuple`. Vร nhแปฏng giรก trแป nแปi tแบกi cลฉng cรณ thแป cรณ kiแปu dแปฏ liแปu cแปงa chรบng.
+
+Nhแปฏng kiแปu dแปฏ liแปu nแปi bแป nร y ฤฦฐแปฃc gแปi lร nhแปฏng kiแปu dแปฏ liแปu "**tแปng quรกt**". Vร cรณ khแบฃ nฤng khai bรกo chรบng, thแบญm chรญ vแปi cรกc kiแปu dแปฏ liแปu nแปi bแป cแปงa chรบng.
+
+ฤแป khai bรกo nhแปฏng kiแปu dแปฏ liแปu vร nhแปฏng kiแปu dแปฏ liแปu nแปi bแป ฤรณ, bแบกn cรณ thแป sแปญ dแปฅng mรด ฤun chuแบฉn cแปงa Python lร `typing`. Nรณ cรณ hแป trแปฃ nhแปฏng gแปฃi รฝ kiแปu dแปฏ liแปu nร y.
+
+#### Nhแปฏng phiรชn bแบฃn mแปi hฦกn cแปงa Python
+
+Cรบ phรกp sแปญ dแปฅng `typing` **tฦฐฦกng thรญch** vแปi tแบฅt cแบฃ cรกc phiรชn bแบฃn, tแปซ Python 3.6 tแปi nhแปฏng phiรชn bแบฃn cuแปi cรนng, bao gแปm Python 3.9, Python 3.10,...
+
+As Python advances, **nhแปฏng phiรชn bแบฃn mแปi** mang tแปi sแปฑ hแป trแปฃ ฤฦฐแปฃc cแบฃi tiแบฟn cho nhแปฏng chรบ thรญch kiแปu dแปฏ liแปu vร trong nhiแปu trฦฐแปng hแปฃp bแบกn thแบญm chรญ sแบฝ khรดng cแบงn import vร sแปญ dแปฅng mรด ฤun `typing` ฤแป khai bรกo chรบ thรญch kiแปu dแปฏ liแปu.
+
+Nแบฟu bแบกn cรณ thแป chแปn mแปt phiรชn bแบฃn Python gแบงn ฤรขy hฦกn cho dแปฑ รกn cแปงa bแบกn, ban sแบฝ cรณ ฤฦฐแปฃc nhแปฏng ฦฐu ฤiแปm cแปงa nhแปฏng cแบฃi tiแบฟn ฤฦกn giแบฃn ฤรณ.
+
+Trong tแบฅt cแบฃ cรกc tร i liแปu tแปn tแบกi nhแปฏng vรญ dแปฅ tฦฐฦกng thรญch vแปi mแปi phiรชn bแบฃn Python (khi cรณ mแปt sแปฑ khรกc nhau).
+
+Cho vรญ dแปฅ "**Python 3.6+**" cรณ nghฤฉa lร nรณ tฦฐฦกng thรญch vแปi Python 3.7 hoแบทc lแปn hฦกn (bao gแปm 3.7, 3.8, 3.9, 3.10,...). vร "**Python 3.9+**" nghฤฉa lร nรณ tฦฐฦกng thรญch vแปi Python 3.9 trแป lรชn (bao gแปm 3.10,...).
+
+Nแบฟu bแบกn cรณ thแป sแปญ dแปฅng **phiรชn bแบฃn cuแปi cรนng cแปงa Python**, sแปญ dแปฅng nhแปฏng vรญ dแปฅ cho phiรชn bแบฃn cuแปi, nhแปฏng cรกi ฤรณ sแบฝ cรณ **cรบ phรกp ฤฦกn giแบฃn vร tแปt nhรขt**, vรญ dแปฅ, "**Python 3.10+**".
+
+#### List
+
+Vรญ dแปฅ, hรฃy ฤแปnh nghฤฉa mแปt biแบฟn lร `list` cรกc `str`.
+
+=== "Python 3.9+"
+
+ Khai bรกo biแบฟn vแปi cรนng dแบฅu hai chแบฅm (`:`).
+
+ Tฦฐฦกng tแปฑ kiแปu dแปฏ liแปu `list`.
+
+ Nhฦฐ danh sรกch lร mแปt kiแปu dแปฏ liแปu chแปฉa mแปt vร i kiแปu dแปฏ liแปu cรณ sแบตn, bแบกn ฤแบทt chรบng trong cรกc dแบฅu ngoแบทc vuรดng:
+
+ ```Python hl_lines="1"
+ {!> ../../../docs_src/python_types/tutorial006_py39.py!}
+ ```
+
+=== "Python 3.8+"
+
+ Tแปซ `typing`, import `List` (vแปi chแปฏ cรกi `L` viแบฟt hoa):
+
+ ``` Python hl_lines="1"
+ {!> ../../../docs_src/python_types/tutorial006.py!}
+ ```
+
+ Khai bรกo biแบฟn vแปi cรนng dแบฅu hai chแบฅm (`:`).
+
+ Tฦฐฦกng tแปฑ nhฦฐ kiแปu dแปฏ liแปu, `List` bแบกn import tแปซ `typing`.
+
+ Nhฦฐ danh sรกch lร mแปt kiแปu dแปฏ liแปu chแปฉa cรกc kiแปu dแปฏ liแปu cรณ sแบตn, bแบกn ฤแบทt chรบng bรชn trong dแบฅu ngoแบทc vuรดng:
+
+ ```Python hl_lines="4"
+ {!> ../../../docs_src/python_types/tutorial006.py!}
+ ```
+
+!!! info
+ Cรกc kiแปu dแปฏ liแปu cรณ sแบตn bรชn trong dแบฅu ngoแบทc vuรดng ฤฦฐแปฃc gแปi lร "tham sแป kiแปu dแปฏ liแปu".
+
+ Trong trฦฐแปng hแปฃp nร y, `str` lร tham sแป kiแปu dแปฏ liแปu ฤฦฐแปฃc truyแปn tแปi `List` (hoแบทc `list` trong Python 3.9 trแป lรชn).
+
+Cรณ nghฤฉa lร : "biแบฟn `items` lร mแปt `list`, vร mแปi phแบงn tแปญ trong danh sรกch nร y lร mแปt `str`".
+
+!!! tip
+ Nแบฟu bแบกn sแปญ dแปฅng Python 3.9 hoแบทc lแปn hฦกn, bแบกn khรดng phแบฃi import `List` tแปซ `typing`, bแบกn cรณ thแป sแปญ dแปฅng `list` ฤแป thay thแบฟ.
+
+Bแบฑng cรกch nร y, trรฌnh soแบกn thแบฃo cแปงa bแบกn cรณ thแป hแป trแปฃ trong khi xแปญ lรญ cรกc phแบงn tแปญ trong danh sรกch:
+
+
+
+ฤa phแบงn ฤแปu khรดng thแป ฤแบกt ฤฦฐแปฃc nแบฟu khรดng cรณ cรกc kiแปu dแปฏ liแปu.
+
+Chรบ รฝ rแบฑng, biแบฟn `item` lร mแปt trong cรกc phแบงn tแปญ trong danh sรกch `items`.
+
+Vร do vแบญy, trรฌnh soแบกn thแบฃo biแบฟt nรณ lร mแปt `str`, vร cung cแบฅp sแปฑ hแป trแปฃ cho nรณ.
+
+#### Tuple and Set
+
+Bแบกn sแบฝ lร m ฤiแปu tฦฐฦกng tแปฑ ฤแป khai bรกo cรกc `tuple` vร cรกc `set`:
+
+=== "Python 3.9+"
+
+ ```Python hl_lines="1"
+ {!> ../../../docs_src/python_types/tutorial007_py39.py!}
+ ```
+
+=== "Python 3.8+"
+
+ ```Python hl_lines="1 4"
+ {!> ../../../docs_src/python_types/tutorial007.py!}
+ ```
+
+ฤiแปu nร y cรณ nghฤฉa lร :
+
+* Biแบฟn `items_t` lร mแปt `tuple` vแปi 3 phแบงn tแปญ, mแปt `int`, mแปt `int` nแปฏa, vร mแปt `str`.
+* Biแบฟn `items_s` lร mแปt `set`, vร mแปi phแบงn tแปญ cแปงa nรณ cรณ kiแปu `bytes`.
+
+#### Dict
+
+ฤแป ฤแปnh nghฤฉa mแปt `dict`, bแบกn truyแปn 2 tham sแป kiแปu dแปฏ liแปu, phรขn cรกch bแปi dแบฅu phแบฉy.
+
+Tham sแป kiแปu dแปฏ liแปu ฤแบงu tiรชn dร nh cho khรณa cแปงa `dict`.
+
+Tham sแป kiแปu dแปฏ liแปu thแปฉ hai dร nh cho giรก trแป cแปงa `dict`.
+
+=== "Python 3.9+"
+
+ ```Python hl_lines="1"
+ {!> ../../../docs_src/python_types/tutorial008_py39.py!}
+ ```
+
+=== "Python 3.8+"
+
+ ```Python hl_lines="1 4"
+ {!> ../../../docs_src/python_types/tutorial008.py!}
+ ```
+
+ฤiแปu nร y cรณ nghฤฉa lร :
+
+* Biแบฟn `prices` lร mแปt `dict`:
+ * Khรณa cแปงa `dict` nร y lร kiแปu `str` (ฤรณ lร tรชn cแปงa mแปi vแบญt phแบฉm).
+ * Giรก trแป cแปงa `dict` nร y lร kiแปu `float` (ฤรณ lร giรก cแปงa mแปi vแบญt phแบฉm).
+
+#### Union
+
+Bแบกn cรณ thแป khai bรกo rแบฑng mแปt biแบฟn cรณ thแป lร **mแปt vร i kiแปu dแปฏ liแปu" bแบฅt kรฌ, vรญ dแปฅ, mแปt `int` hoแบทc mแปt `str`.
+
+Trong Python 3.6 hoแบทc lแปn hฦกn (bao gแปm Python 3.10) bแบกn cรณ thแป sแปญ dแปฅng kiแปu `Union` tแปซ `typing` vร ฤแบทt trong dแบฅu ngoแบทc vuรดng nhแปฏng giรก trแป ฤฦฐแปฃc chแบฅp nhแบญn.
+
+In Python 3.10 there's also a **new syntax** where you can put the possible types separated by a vertical bar (`|`).
+
+Trong Python 3.10 cลฉng cรณ mแปt **cรบ phรกp mแปi** mร bแบกn cรณ thแป ฤแบทt nhแปฏng kiแปu giรก trแป khแบฃ thi phรขn cรกch bแปi mแปt dแบฅu sแป dแปc (`|`).
+
+
+=== "Python 3.10+"
+
+ ```Python hl_lines="1"
+ {!> ../../../docs_src/python_types/tutorial008b_py310.py!}
+ ```
+
+=== "Python 3.8+"
+
+ ```Python hl_lines="1 4"
+ {!> ../../../docs_src/python_types/tutorial008b.py!}
+ ```
+
+Trong cแบฃ hai trฦฐแปng hแปฃp cรณ nghฤฉa lร `item` cรณ thแป lร mแปt `int` hoแบทc `str`.
+
+#### Khแบฃ nฤng `None`
+
+Bแบกn cรณ thแป khai bรกo mแปt giรก trแป cรณ thแป cรณ mแปt kiแปu dแปฏ liแปu, giแปng nhฦฐ `str`, nhฦฐng nรณ cลฉng cรณ thแป lร `None`.
+
+Trong Python 3.6 hoแบทc lแปn hฦกn (bao gแปm Python 3.10) bแบกn cรณ thแป khai bรกo nรณ bแบฑng cรกc import vร sแปญ dแปฅng `Optional` tแปซ mรด ฤun `typing`.
+
+```Python hl_lines="1 4"
+{!../../../docs_src/python_types/tutorial009.py!}
+```
+
+Sแปญ dแปฅng `Optional[str]` thay cho `str` sแบฝ cho phรฉp trรฌnh soแบกn thแบฃo giรบp bแบกn phรกt hiแปn cรกc lแปi mร bแบกn cรณ thแป gแบทp nhฦฐ mแปt giรก trแป luรดn lร mแปt `str`, trong khi thแปฑc tแบฟ nรณ rแบฅt cรณ thแป lร `None`.
+
+`Optional[Something]` lร mแปt cรกch viแบฟt ngแบฏn gแปn cแปงa `Union[Something, None]`, chรบng lร tฦฐฦกng ฤฦฐฦกng nhau.
+
+ฤiแปu nร y cลฉng cรณ nghฤฉa lร trong Python 3.10, bแบกn cรณ thแป sแปญ dแปฅng `Something | None`:
+
+=== "Python 3.10+"
+
+ ```Python hl_lines="1"
+ {!> ../../../docs_src/python_types/tutorial009_py310.py!}
+ ```
+
+=== "Python 3.8+"
+
+ ```Python hl_lines="1 4"
+ {!> ../../../docs_src/python_types/tutorial009.py!}
+ ```
+
+=== "Python 3.8+ alternative"
+
+ ```Python hl_lines="1 4"
+ {!> ../../../docs_src/python_types/tutorial009b.py!}
+ ```
+
+#### Sแปญ dแปฅng `Union` hay `Optional`
+
+If you are using a Python version below 3.10, here's a tip from my very **subjective** point of view:
+
+Nแบฟu bแบกn ฤang sแปญ dแปฅng phiรชn bแบฃn Python dฦฐแปi 3.10, ฤรขy lร mแปt mแบนo tแปซ รฝ kiแบฟn rแบฅt "chแปง quan" cแปงa tรดi:
+
+* ๐จ Trรกnh sแปญ dแปฅng `Optional[SomeType]`
+* Thay vร o ฤรณ โจ **sแปญ dแปฅng `Union[SomeType, None]`** โจ.
+
+Cแบฃ hai lร tฦฐฦกng ฤฦฐฦกng vร bรชn dฦฐแปi chรบng giแปng nhau, nhฦฐng tรดi sแบฝ ฤแป
xuแบฅt `Union` thay cho `Optional` vรฌ tแปซ "**tรนy chแปn**" cรณ vแบป ngแบงm ฤแปnh giรก trแป lร tรนy chแปn, vร nรณ thแปฑc sแปฑ cรณ nghฤฉa rแบฑng "nรณ cรณ thแป lร `None`", do ฤรณ nรณ khรดng phแบฃi lร tรนy chแปn vร nรณ vแบซn ฤฦฐแปฃc yรชu cแบงu.
+
+Tรดi nghฤฉ `Union[SomeType, None]` lร rรต rร ng hฦกn vแป รฝ nghฤฉa cแปงa nรณ.
+
+Nรณ chแป lร vแป cรกc tแปซ vร tรชn. Nhฦฐng nhแปฏng tแปซ ฤรณ cรณ thแป แบฃnh hฦฐแปng cรกch bแบกn vร nhแปฏng ฤแปng ฤแปi cแปงa bแบกn suy nghฤฉ vแป code.
+
+Cho mแปt vรญ dแปฅ, hรฃy ฤแป รฝ hร m nร y:
+
+```Python hl_lines="1 4"
+{!../../../docs_src/python_types/tutorial009c.py!}
+```
+
+Tham sแป `name` ฤฦฐแปฃc ฤแปnh nghฤฉa lร `Optional[str]`, nhฦฐng nรณ **khรดng phแบฃi lร tรนy chแปn**, bแบกn khรดng thแป gแปi hร m mร khรดng cรณ tham sแป:
+
+```Python
+say_hi() # Oh, no, this throws an error! ๐ฑ
+```
+
+Tham sแป `name` **vแบซn ฤฦฐแปฃc yรชu cแบงu** (khรดng phแบฃi lร *tรนy chแปn*) vรฌ nรณ khรดng cรณ giรก trแป mแบทc ฤแปnh. Trong khi ฤรณ, `name` chแบฅp nhแบญn `None` nhฦฐ lร giรก trแป:
+
+```Python
+say_hi(name=None) # This works, None is valid ๐
+```
+
+Tin tแปt lร , khi bแบกn sแปญ dแปฅng Python 3.10, bแบกn sแบฝ khรดng phแบฃi lo lแบฏng vแป ฤiแปu ฤรณ, bแบกn sแบฝ cรณ thแป sแปญ dแปฅng `|` ฤแป ฤแปnh nghฤฉa hแปฃp cแปงa cรกc kiแปu dแปฏ liแปu mแปt cรกch ฤฦกn giแบฃn:
+
+```Python hl_lines="1 4"
+{!../../../docs_src/python_types/tutorial009c_py310.py!}
+```
+
+Vร sau ฤรณ, bแบกn sแบฝ khรดng phแบฃi lo rแบฑng nhแปฏng cรกi tรชn nhฦฐ `Optional` vร `Union`. ๐
+
+
+#### Nhแปฏng kiแปu dแปฏ liแปu tแปng quรกt
+
+Nhแปฏng kiแปu dแปฏ liแปu nร y lแบฅy tham sแป kiแปu dแปฏ liแปu trong dแบฅu ngoแบทc vuรดng ฤฦฐแปฃc gแปi lร **Kiแปu dแปฏ liแปu tแปng quรกt**, cho vรญ dแปฅ:
+
+=== "Python 3.10+"
+
+ Bแบกn cรณ thแป sแปญ dแปฅng cรกc kiแปu dแปฏ liแปu cรณ sแบตn nhฦฐ lร kiแปu dแปฏ liแปu tแปng quรกt (vแปi ngoแบทc vuรดng vร kiแปu dแปฏ liแปu bรชn trong):
+
+ * `list`
+ * `tuple`
+ * `set`
+ * `dict`
+
+ Vร tฦฐฦกng tแปฑ vแปi Python 3.6, tแปซ mรด ฤun `typing`:
+
+ * `Union`
+ * `Optional` (tฦฐฦกng tแปฑ nhฦฐ Python 3.6)
+ * ...vร cรกc kiแปu dแปฏ liแปu khรกc.
+
+ Trong Python 3.10, thay vรฌ sแปญ dแปฅng `Union` vร `Optional`, bแบกn cรณ thแป sแปญ dแปฅng sแป dแปc ('|') ฤแป khai bรกo hแปฃp cแปงa cรกc kiแปu dแปฏ liแปu, ฤiแปu ฤรณ tแปt hฦกn vร ฤฦกn giแบฃn hฦกn nhiแปu.
+
+=== "Python 3.9+"
+
+ Bแบกn cรณ thแป sแปญ dแปฅng cรกc kiแปu dแปฏ liแปu cรณ sแบตn tฦฐฦกng tแปฑ nhฦฐ (vแปi ngoแบทc vuรดng vร kiแปu dแปฏ liแปu bรชn trong):
+
+ * `list`
+ * `tuple`
+ * `set`
+ * `dict`
+
+ Vร tฦฐฦกng tแปฑ vแปi Python 3.6, tแปซ mรด ฤun `typing`:
+
+ * `Union`
+ * `Optional`
+ * ...and others.
+
+=== "Python 3.8+"
+
+ * `List`
+ * `Tuple`
+ * `Set`
+ * `Dict`
+ * `Union`
+ * `Optional`
+ * ...vร cรกc kiแปu khรกc.
+
+### Lแปp nhฦฐ kiแปu dแปฏ liแปu
+
+Bแบกn cลฉng cรณ thแป khai bรกo mแปt lแปp nhฦฐ lร kiแปu dแปฏ liแปu cแปงa mแปt biแบฟn.
+
+Hรฃy nรณi rแบฑng bแบกn muแปn cรณ mแปt lแปp `Person` vแปi mแปt tรชn:
+
+```Python hl_lines="1-3"
+{!../../../docs_src/python_types/tutorial010.py!}
+```
+
+Sau ฤรณ bแบกn cรณ thแป khai bรกo mแปt biแบฟn cรณ kiแปu lร `Person`:
+
+```Python hl_lines="6"
+{!../../../docs_src/python_types/tutorial010.py!}
+```
+
+Vร lแบกi mแปt lแบงn nแปฏa, bแบกn cรณ ฤฦฐแปฃc tแบฅt cแบฃ sแปฑ hแป trแปฃ tแปซ trรฌnh soแบกn thแบฃo:
+
+
+
+Lฦฐu รฝ rแบฑng, ฤiแปu nร y cรณ nghฤฉa rแบฑng "`one_person`" lร mแปt **thแปฑc thแป** cแปงa lแปp `Person`.
+
+Nรณ khรดng cรณ nghฤฉa "`one_person`" lร mแปt **lแปp** gแปi lร `Person`.
+
+## Pydantic models
+
+Pydantic lร mแปt thฦฐ viแปn Python ฤแป validate dแปฏ liแปu hiแปu nฤng cao.
+
+Bแบกn cรณ thแป khai bรกo "hรฌnh dแบกng" cแปงa dแปฏa liแปu nhฦฐ lร cรกc lแปp vแปi cรกc thuแปc tรญnh.
+
+Vร mแปi thuแปc tรญnh cรณ mแปt kiแปu dแปฏ liแปu.
+
+Sau ฤรณ bแบกn tแบกo mแปt thแปฑc thแป cแปงa lแปp ฤรณ vแปi mแปt vร i giรก trแป vร nรณ sแบฝ validate cรกc giรก trแป, chuyแปn ฤแปi chรบng sang kiแปu dแปฏ liแปu phรน hแปฃp (nแบฟu ฤรณ lร trฦฐแปng hแปฃp) vร cho bแบกn mแปt object vแปi toร n bแป dแปฏ liแปu.
+
+Vร bแบกn nhแบญn ฤฦฐแปฃc tแบฅt cแบฃ sแปฑ hแป trแปฃ cแปงa trรฌnh soแบกn thแบฃo vแปi object kแบฟt quแบฃ ฤรณ.
+
+Mแปt vรญ dแปฅ tแปซ tร i liแปu chรญnh thแปฉc cแปงa Pydantic:
+
+=== "Python 3.10+"
+
+ ```Python
+ {!> ../../../docs_src/python_types/tutorial011_py310.py!}
+ ```
+
+=== "Python 3.9+"
+
+ ```Python
+ {!> ../../../docs_src/python_types/tutorial011_py39.py!}
+ ```
+
+=== "Python 3.8+"
+
+ ```Python
+ {!> ../../../docs_src/python_types/tutorial011.py!}
+ ```
+
+!!! info
+ ฤแป hแปc nhiแปu hฦกn vแป Pydantic, tham khแบฃo tร i liแปu cแปงa nรณ.
+
+**FastAPI** ฤฦฐแปฃc dแปฑa hoร n toร n trรชn Pydantic.
+
+Bแบกn sแบฝ thแบฅy nhiแปu vรญ dแปฅ thแปฑc tแบฟ hฦกn trong [Hฦฐแปng dแบซn sแปญ dแปฅng](tutorial/index.md){.internal-link target=_blank}.
+
+!!! tip
+ Pydantic cรณ mแปt hร nh vi ฤแบทc biแปt khi bแบกn sแปญ dแปฅng `Optional` hoแบทc `Union[Something, None]` mร khรดng cรณ giรก trแป mแบทc dแปnh, bแบกn cรณ thแป ฤแปc nhiแปu hฦกn vแป nรณ trong tร i liแปu cแปงa Pydantic vแป Required Optional fields.
+
+
+## Type Hints vแปi Metadata Annotations
+
+Python cลฉng cรณ mแปt tรญnh nฤng cho phรฉp ฤแบทt **metadata bแป sung** trong nhแปฏng gแปฃi รฝ kiแปu dแปฏ liแปu nร y bแบฑng cรกch sแปญ dแปฅng `Annotated`.
+
+=== "Python 3.9+"
+
+ Trong Python 3.9, `Annotated` lร mแปt phแบงn cแปงa thฦฐ viแปn chuแบฉn, do ฤรณ bแบกn cรณ thแป import nรณ tแปซ `typing`.
+
+ ```Python hl_lines="1 4"
+ {!> ../../../docs_src/python_types/tutorial013_py39.py!}
+ ```
+
+=== "Python 3.8+"
+
+ แป phiรชn bแบฃn dฦฐแปi Python 3.9, bแบกn import `Annotated` tแปซ `typing_extensions`.
+
+ Nรณ ฤรฃ ฤฦฐแปฃc cร i ฤแบทt sแบตng cรนng vแปi **FastAPI**.
+
+ ```Python hl_lines="1 4"
+ {!> ../../../docs_src/python_types/tutorial013.py!}
+ ```
+
+Python bแบฃn thรขn nรณ khรดng lร m bแบฅt kรฌ ฤiแปu gรฌ vแปi `Annotated`. Vแปi cรกc trรฌnh soแบกn thแบฃo vร cรกc cรดng cแปฅ khรกc, kiแปu dแปฏ liแปu vแบซn lร `str`.
+
+Nhฦฐng bแบกn cรณ thแป sแปญ dแปฅng `Annotated` ฤแป cung cแบฅp cho **FastAPI** metadata bแป sung vแป cรกch mร bแบกn muแปn แปฉng dแปฅng cแปงa bแบกn xแปญ lรญ.
+
+ฤiแปu quan trแปng cแบงn nhแป lร ***tham sแป kiแปu dแปฏ liแปu* ฤแบงu tiรชn** bแบกn truyแปn tแปi `Annotated` lร **kiแปu giรก trแป thแปฑc sแปฑ**. Phแบงn cรฒn lแบกi chแป lร metadata cho cรกc cรดng cแปฅ khรกc.
+
+Bรขy giแป, bแบกn chแป cแบงn biแบฟt rแบฑng `Annotated` tแปn tแบกi, vร nรณ lร tiรชu chuแบฉn cแปงa Python. ๐
+
+
+Sau ฤรณ, bแบกn sแบฝ thแบฅy sแปฑ **mแบกnh mแบฝ** mร nรณ cรณ thแป lร m.
+
+!!! tip
+ Thแปฑc tแบฟ, cรกi nร y lร **tiรชu chuแบฉn cแปงa Python**, nghฤฉa lร bแบกn vแบซn sแบฝ cรณ ฤฦฐแปฃc **trแบฃi nghiแปm phรกt triแปn tแปt nhแบฅt cรณ thแป** vแปi trรฌnh soแบกn thแบฃo cแปงa bแบกn, vแปi cรกc cรดng cแปฅ bแบกn sแปญ dแปฅng ฤแป phรขn tรญch vร tรกi cแบฅu trรบc code cแปงa bแบกn, etc. โจ
+
+ Vร code cแปงa bแบกn sแบฝ tฦฐฦกng thรญch vแปi nhiแปu cรดng cแปฅ vร thฦฐ viแปn khรกc cแปงa Python. ๐
+
+## Cรกc gแปฃi รฝ kiแปu dแปฏ liแปu trong **FastAPI**
+
+**FastAPI** lแบฅy cรกc ฦฐu ฤiแปm cแปงa cรกc gแปฃi รฝ kiแปu dแปฏ liแปu ฤแป thแปฑc hiแปn mแปt sแป thแปฉ.
+
+Vแปi **FastAPI**, bแบกn khai bรกo cรกc tham sแป vแปi gแปฃi รฝ kiแปu vร bแบกn cรณ ฤฦฐแปฃc:
+
+* **Sแปฑ hแป trแปฃ tแปซ cรกc trรฌnh soแบกn thแบฃo**.
+* **Kiแปm tra kiแปu dแปฏ liแปu (type checking)**.
+
+...vร **FastAPI** sแปญ dแปฅng cรกc khia bรกo ฤแป:
+
+* **ฤแปnh nghฤฉa cรกc yรชu cแบงu**: tแปซ tham sแป ฤฦฐแปng dแบซn cแปงa request, tham sแป query, headers, bodies, cรกc phแปฅ thuแปc (dependencies),...
+* **Chuyแปn dแปi dแปฏ liแปu*: tแปซ request sang kiแปu dแปฏ liแปu ฤฦฐแปฃc yรชu cแบงu.
+* **Kiแปm tra tรญnh ฤรบng ฤแบฏn cแปงa dแปฏ liแปu**: tแปi tแปซ mแปi request:
+ * Sinh **lแปi tแปฑ ฤแปng** ฤแป trแบฃ vแป mรกy khรกc khi dแปฏ liแปu khรดng hแปฃp lแป.
+* **Tร i liแปu hรณa** API sแปญ dแปฅng OpenAPI:
+ * cรกi mร sau ฤฦฐแปฃc ฤฦฐแปฃc sแปญ dแปฅng bแปi tร i liแปu tฦฐฦกng tรกc ngฦฐแปi dรนng.
+
+ฤiแปu nร y cรณ thแป nghe trแปซu tฦฐแปฃng. ฤแปซng lo lแบฏng. Bแบกn sแบฝ thแบฅy tแบฅt cแบฃ chรบng trong [Hฦฐแปng dแบซn sแปญ dแปฅng](tutorial/index.md){.internal-link target=_blank}.
+
+ฤiแปu quan trแปng lร bแบฑng viแปc sแปญ dแปฅng cรกc kiแปu dแปฏ liแปu chuแบฉn cแปงa Python (thay vรฌ thรชm cรกc lแปp, decorators,...), **FastAPI** sแบฝ thแปฑc hiแปn nhiแปu cรดng viแปc cho bแบกn.
+
+!!! info
+ Nแบฟu bแบกn ฤรฃ ฤi qua toร n bแป cรกc hฦฐแปng dแบซn vร quay trแป lแบกi ฤแป tรฌm hiแปu nhiแปu hฦกn vแป cรกc kiแปu dแปฏ liแปu, mแปt tร i nguyรชn tแปt nhฦฐ "cheat sheet" tแปซ `mypy`.
diff --git a/docs/vi/docs/tutorial/first-steps.md b/docs/vi/docs/tutorial/first-steps.md
new file mode 100644
index 000000000..712f00852
--- /dev/null
+++ b/docs/vi/docs/tutorial/first-steps.md
@@ -0,0 +1,333 @@
+# Nhแปฏng bฦฐแปc ฤแบงu tiรชn
+
+Tแปp tin FastAPI ฤฦกn giแบฃn nhแบฅt cรณ thแป trรดng nhฦฐ nร y:
+
+```Python
+{!../../../docs_src/first_steps/tutorial001.py!}
+```
+
+Sao chรฉp sang mแปt tแปp tin `main.py`.
+
+Chแบกy live server:
+
+get
+
+!!! info Thรดng tin vแป "`@decorator`"
+ Cรบ phรกp `@something` trong Python ฤฦฐแปฃc gแปi lร mแปt "decorator".
+
+ Bแบกn ฤแบทt nรณ trรชn mแปt hร m. Giแปng nhฦฐ mแปt chiแบฟc mลฉ xinh xแบฏn (Tรดi ddonas ฤรณ lร lรญ do mร thuแบญt ngแปฏ nร y ra ฤแปi).
+
+ Mแปt "decorator" lแบฅy mแปt hร m bรชn dฦฐแปi vร thแปฑc hiแปn mแปt vร i thแปฉ vแปi nรณ.
+
+ Trong trฦฐแปng hแปฃp cแปงa chรบng ta, decorator nร y nรณi **FastAPI** rแบฑng hร m bรชn dฦฐแปi แปฉng vแปi **ฤฦฐแปng dแบซn** `/` vร mแปt **toรกn tแปญ** `get`.
+
+ Nรณ lร mแปt "**decorator ฤฦฐแปng dแบซn toรกn tแปญ**".
+
+Bแบกn cลฉng cรณ thแป sแปญ dแปฅng vแปi cรกc toรกn tแปญ khรกc:
+
+* `@app.post()`
+* `@app.put()`
+* `@app.delete()`
+
+Vร nhiแปu hฦกn vแปi cรกc toรกn tแปญ cรฒn lแบกi:
+
+* `@app.options()`
+* `@app.head()`
+* `@app.patch()`
+* `@app.trace()`
+
+!!! tip
+ Bแบกn thoแบฃi mรกi sแปญ dแปฅng mแปi toรกn tแปญ (phฦฐฦกng thแปฉc HTTP) nhฦฐ bแบกn mฦก ฦฐแปc.
+
+ **FastAPI** khรดng bแบฏt buแปc bแบฅt kรฌ รฝ nghฤฉa cแปฅ thแป nร o.
+
+ Thรดng tin แป ฤรขy ฤฦฐแปฃc biแปu thแป nhฦฐ lร mแปt chแป dแบซn, khรดng phแบฃi lร mแปt yรชu cแบงu bแบฏt buแปc.
+
+ Vรญ dแปฅ, khi sแปญ dแปฅng GraphQL bแบกn thรดng thฦฐแปng thแปฑc hiแปn tแบฅt cแบฃ cรกc hร nh ฤแปng chแป bแบฑng viแปc sแปญ dแปฅng cรกc toรกn tแปญ `POST`.
+
+### Step 4: ฤแปnh nghฤฉa **hร m cho ฤฦฐแปng dแบซn toรกn tแปญ**
+
+ฤรขy lร "**hร m cho ฤฦฐแปng dแบซn toรกn tแปญ**":
+
+* **ฤฦฐแปng dแบซn**: lร `/`.
+* **toรกn tแปญ**: lร `get`.
+* **hร m**: lร hร m bรชn dฦฐแปi "decorator" (bรชn dฦฐแปi `@app.get("/")`).
+
+```Python hl_lines="7"
+{!../../../docs_src/first_steps/tutorial001.py!}
+```
+
+ฤรขy lร mแปt hร m Python.
+
+Nรณ sแบฝ ฤฦฐแปฃc gแปi bแปi **FastAPI** bแบฅt cแปฉ khi nร o nรณ nhแบญn mแปt request tแปi URL "`/`" sแปญ dแปฅng mแปt toรกn tแปญ `GET`.
+
+Trong trฦฐแปng hแปฃp nร y, nรณ lร mแปt hร m `async`.
+
+---
+
+Bแบกn cลฉng cรณ thแป ฤแปnh nghฤฉa nรณ nhฦฐ lร mแปt hร m thรดng thฦฐแปng thay cho `async def`:
+
+```Python hl_lines="7"
+{!../../../docs_src/first_steps/tutorial003.py!}
+```
+
+!!! note
+ Nแบฟu bแบกn khรดng biแบฟt sแปฑ khรกc nhau, kiแปm tra [Async: *"Trong khi vแปi vร ng?"*](../async.md#in-a-hurry){.internal-link target=_blank}.
+
+### Bฦฐแปc 5: Nแปi dung trแบฃ vแป
+
+```Python hl_lines="8"
+{!../../../docs_src/first_steps/tutorial001.py!}
+```
+
+Bแบกn cรณ thแป trแบฃ vแป mแปt `dict`, `list`, mแปt trong nhแปฏng giรก trแป ฤฦกn nhฦฐ `str`, `int`,...
+
+Bแบกn cลฉng cรณ thแป trแบฃ vแป Pydantic model (bแบกn sแบฝ thแบฅy nhiแปu hฦกn vแป nรณ sau).
+
+Cรณ nhiแปu object vร model khรกc nhau sแบฝ ฤฦฐแปฃc tแปฑ ฤแปng chuyแปn ฤแปi sang JSON (bao gแปm cแบฃ ORM,...). Thแปญ sแปญ dแปฅng loแบกi ฦฐa thรญch cแปงa bแบกn, nรณ cรณ khแบฃ nฤng cao ฤรฃ ฤฦฐแปฃc hแป trแปฃ.
+
+## Tรณm lแบกi
+
+* Import `FastAPI`.
+* Tแบกo mแปt `app` instance.
+* Viแบฟt mแปt **decorator cho ฤฦฐแปng dแบซn toรกn tแปญ** (giแปng nhฦฐ `@app.get("/")`).
+* Viแบฟt mแปt **hร m cho ฤฦฐแปng dแบซn toรกn tแปญ** (giแปng nhฦฐ `def root(): ...` แป trรชn).
+* Chแบกy server trong mรดi trฦฐแปng phรกt triแปn (giแปng nhฦฐ `uvicorn main:app --reload`).
diff --git a/docs/vi/docs/tutorial/index.md b/docs/vi/docs/tutorial/index.md
new file mode 100644
index 000000000..e8a93fe40
--- /dev/null
+++ b/docs/vi/docs/tutorial/index.md
@@ -0,0 +1,80 @@
+# Hฦฐแปng dแบซn sแปญ dแปฅng
+
+Hฦฐแปng dแบซn nร y cho bแบกn thแบฅy tแปซng bฦฐแปc cรกch sแปญ dแปฅng **FastAPI** ฤa sแป cรกc tรญnh nฤng cแปงa nรณ.
+
+Mแปi phแบงn ฤฦฐแปฃc xรขy dแปฑng tแปซ nhแปฏng phแบงn trฦฐแปc ฤรณ, nhฦฐng nรณ ฤฦฐแปฃc cแบฅu trรบc thร nh cรกc chแปง ฤแป riรชng biแปt, do ฤรณ bแบกn cรณ thแป xem trแปฑc tiแบฟp tแปซng phแบงn cแปฅ thแป bแบฅt kรฌ ฤแป giแบฃi quyแบฟt nhแปฏng API cแปฅ thแป mร bแบกn cแบงn.
+
+Nรณ cลฉng ฤฦฐแปฃc xรขy dแปฑng ฤแป lร m viแปc nhฦฐ mแปt tham chiแบฟu trong tฦฐฦกng lai.
+
+Do ฤรณ bแบกn cรณ thแป quay lแบกi vร tรฌm chรญnh xรกc nhแปฏng gรฌ bแบกn cแบงn.
+
+## Chแบกy mรฃ
+
+Tแบฅt cแบฃ cรกc code block cรณ thแป ฤฦฐแปฃc sao chรฉp vร sแปญ dแปฅng trแปฑc tiแบฟp (chรบng thแปฑc chแบฅt lร cรกc tแปp tin Python ฤรฃ ฤฦฐแปฃc kiแปm thแปญ).
+
+ฤแป chแบกy bแบฅt kรฌ vรญ dแปฅ nร o, sao chรฉp code tแปi tแปp tin `main.py`, vร bแบฏt ฤแบงu `uvicorn` vแปi:
+
+
+
+
+ รlร nร wแบนฬแบนฬbรน FastAPI, iแนฃแบนฬ gรญga, รณ rแปrรนn lรกti kแปฬ, o yรกra lรกti kรณรฒdรน, รณ sรฌ แนฃetรกn fรบn iแนฃelแปpแป nรญ lรญlo +
+ + +--- + +**รkแปsรญlแบนฬ**: https://fastapi.tiangolo.com + +**Orisun Kรณรฒdรน**: https://github.com/tiangolo/fastapi + +--- + +FastAPI jแบนฬ รฌgbร lรณdรฉ, tรญ รณ yรกra (iแนฃแบน-giga), รฌlร nร wแบนฬแบนฬbรน fรบn kikแป ร wแปn API pแบนฬlรบ Python 3.8+ รจyรญ tรญ รณ da lori ร wแปn รฌtแปฬkasรญ ร mรฌ irรบfแบนฬ Python. + +รwแปn แบนya pร tร kรฌ ni: + +* **ร yรกra**: Iแนฃแบน tรญ รณ ga pรบpแปฬ, tรญ รณ wa ni ibamu pแบนฬlรบ **NodeJS** ร ti **Go** (แปpแบน si Starlette ร ti Pydantic). [แปkan nรญnรบ ร wแปn รฌlร nร Python ti o yรกra jรนlแป ti o wa](#performance). +* **ร yรกra lรกti kรณรฒdรน**: O mu iyara pแป si lรกti kแป ร wแปn แบนya tuntun kรณรฒdรน nipasแบน "Igba รฌdรก แปgแปฬrรนn-รบn" (i.e. 200%) si "แปฬแปฬdรบrรบn รฌdรก แปgแปฬrรนn-รบn" (i.e. 300%). +* **รรฌtแปฬ kรฉkerรฉ**: O n din aแนฃiแนฃe ku bi แปgbon รฌdรก แปgแปฬrรนn-รบn (i.e. 40%) ti eda eniyan (oแนฃiแนฃแบน kรณรฒdรน) fa. * +* **แปgbแปฬn ร ti รฌmแปฬ**: Atilแบนyin olootu nla. รparรญ nibi gbogbo. รkรณkรฒ dรญแบนฬ nipa wรญwรก ibi tรญ รฌแนฃรฒro kรณรฒdรน wร . +* **Irแปrun**: A kแป kรญ รณ le rแปrun lรกti lo ร ti lรกti kแป แบนkแป nรญnรบ rรจ. ร mรกa fรบn แป nรญ ร kรณkรฒ dรญแบนฬ lรกtฤฑ ka ร kแปsรญlแบน. +* **ร kรบkurรบ nรญ kikแป**: ร dรญn ร tรบnkแป ร ti ร tรบntรฒ kรณรฒdรน kรน. รkรฉde ร แนฃร yร n kแปฬแปฬkan nรญnรบ rแบนฬ nรญ แปฬpแปฬlแปpแปฬ ร wแปn รฌlรฒ. O แนฃe iranlแปwแป lรกti mรก แนฃe nรญ แปฬpแปฬlแปpแปฬ ร แนฃรฌแนฃe. +* **ร lรกgbรกra**: ร ล แนฃe ร gbรฉjรกde kรณรฒdรน tรญ รณ แนฃetรกn fรบn รฌแนฃelแปฬpแปฬ. Pแบนฬlรบ ร kแปsรญlแบนฬ tรญ รณ mรกa แนฃร lร yรฉ ara rแบนฬ fรบn แบน nรญ รฌbรกแนฃepแปฬ alรกdร รกแนฃiแนฃแบนฬ pแบนฬlรบ rรจ. +* **Ajohunลกe/รtแปฬkasรญ**: ร da lori (ร ti ibamu ni kikun pแบนฬlรบ) ร wแปn รฌmแป ajohunลกe/รฌtแปฬkasรญ fรบn ร wแปn API: OpenAPI (รจyรญ tรญ a mแป tแบนlแบน si Swagger) ร ti JSON Schema. + +* iแนฃiro yi da lori ร wแปn idanwo tรญ แบนgbแบน รฌdร gbร sรณkรจ FastAPI แนฃe, nรญgbร tรญ wแปn kแป ร wแปn ohun elo iแนฃelแปpแป kรณรฒdรน pแบนฬlรบ rแบน. + +## รwแปn onรญgbแปฬwแปฬ + + + +{% if sponsors %} +{% for sponsor in sponsors.gold -%} +
+
+Ti o ba n kแป ohun รจlรฒ CLI lรกti แนฃeรฉ lแป nรญnรบ ohun รจlรฒ lori ebute kแปmputa dipo API, แนฃayแบนwo **Typer**.
+
+**Typer** jแบนฬ ร bรบrรฒ รฌyรก FastAPI kรฉkerรฉ. รti pรฉ wแปฬn kแปฬ lรกti jแบนฬ **FastAPI ti CLIs**. โจ๏ธ ๐
+
+## รrรฒjร
+
+Python 3.8+
+
+FastAPI dรบrรณ lรณrรญ ร wแปn รจjรฌkรก tรญ ร wแปn รฒmรญrร n:
+
+* Starlette fรบn ร wแปn แบนฬyร ayรฉlujรกra.
+* Pydantic fรบn ร wแปn แบนฬyร ร kรณjแปf'รกyแบนฬwรฒ.
+
+## Fifi sรณrรญ แบนrแป
+
+
+
+
+
+async def...uvicorn main:app --reload...email_validator - fรบn ifแปwแปsi รญmeรจlรฌ.
+* pydantic-settings - fรบn รจtรฒ รฌsร kรณso.
+* pydantic-extra-types - fรบn ร fikรบn orรญแนฃi lรกti lแป pแบนฬlรบ Pydantic.
+
+รyรญ tรญ Starlette ล lรฒ:
+
+* httpx - Nรญlรฒ tรญ รณ bรก fแบนฬ lรกti lแป `TestClient`.
+* jinja2 - Nรญlรฒ tรญ รณ bรก fแบนฬ lรกti lแป iแนฃeto awoแนฃe aiyipada.
+* python-multipart - Nรญlรฒ tรญ รณ bรก fแบนฬ lรกti แนฃe ร tรฌlแบนฬyรฌn fรบn "ร yแบนฬwรฒ" fแปแปmu, pแบนฬlรบ `request.form()`.
+* itsdangerous - Nรญlรฒ fรบn ร tรฌlแบนฬyรฌn `SessionMiddleware`.
+* pyyaml - Nรญlรฒ fรบn ร tรฌlแบนฬyรฌn Starlette's `SchemaGenerator` (รณ แนฃe แนฃe kรญ รณ mรก nรญlรฒ rแบนฬ fรบn FastAPI).
+* ujson - Nรญlรฒ tรญ รณ bรก fแบนฬ lรกti lแป `UJSONResponse`.
+
+รyรญ tรญ FastAPI / Starlette ล lรฒ:
+
+* uvicorn - Fรบn olupin tรญ yรณรฒ sแบนฬ ร mรบyแบน ร ti tรญ yรณรฒ แนฃe รฌpรจsรจ fรบn iแนฃแบนฬ rแบน tร bรญ ohun รจlรฒ rแบน.
+* orjson - Nรญlรฒ tรญ รณ bรก fแบนฬ lรกti lแป `ORJSONResponse`.
+
+ร lรจ fi gbogbo ร wแปn wแปฬnyรญ sรณrรญ แบนrแป pแบนฬlรบ `pip install "fastapi[all]"`.
+
+## Iwe-aแนฃแบน
+
+Iแนฃแบนฬ yรฌรญ ni iwe-aแนฃแบน lรกbแบนฬ ร wแปn รฒfin tรญ iwe-aแนฃแบน MIT.
diff --git a/docs/yo/mkdocs.yml b/docs/yo/mkdocs.yml
new file mode 100644
index 000000000..de18856f4
--- /dev/null
+++ b/docs/yo/mkdocs.yml
@@ -0,0 +1 @@
+INHERIT: ../en/mkdocs.yml
diff --git a/docs/zh/docs/advanced/generate-clients.md b/docs/zh/docs/advanced/generate-clients.md
new file mode 100644
index 000000000..e222e479c
--- /dev/null
+++ b/docs/zh/docs/advanced/generate-clients.md
@@ -0,0 +1,266 @@
+# ็ๆๅฎขๆท็ซฏ
+
+ๅ ไธบ **FastAPI** ๆฏๅบไบOpenAPI่ง่็๏ผ่ช็ถๆจๅฏไปฅไฝฟ็จ่ฎธๅค็ธๅน้
็ๅทฅๅ
ท๏ผๅ
ๆฌ่ชๅจ็ๆAPIๆๆกฃ (็ฑ Swagger UI ๆไพ)ใ
+
+ไธไธชไธๅคชๆๆพ่ๅ็นๅซ็ไผๅฟๆฏ๏ผไฝ ๅฏไปฅไธบไฝ ็API้ๅฏนไธๅ็**็ผ็จ่ฏญ่จ**ๆฅ**็ๆๅฎขๆท็ซฏ**(ๆๆถๅ่ขซๅซๅ **SDKs** )ใ
+
+## OpenAPI ๅฎขๆท็ซฏ็ๆ
+
+ๆ่ฎธๅคๅทฅๅ
ทๅฏไปฅไป**OpenAPI**็ๆๅฎขๆท็ซฏใ
+
+ไธไธชๅธธ่ง็ๅทฅๅ
ทๆฏ OpenAPI Generatorใ
+
+ๅฆๆๆจๆญฃๅจๅผๅ**ๅ็ซฏ**๏ผไธไธช้ๅธธๆ่ถฃ็ๆฟไปฃๆนๆกๆฏ openapi-typescript-codegenใ
+
+## ็ๆไธไธช TypeScript ๅ็ซฏๅฎขๆท็ซฏ
+
+่ฎฉๆไปฌไปไธไธช็ฎๅ็ FastAPI ๅบ็จๅผๅง๏ผ
+
+=== "Python 3.9+"
+
+ ```Python hl_lines="7-9 12-13 16-17 21"
+ {!> ../../../docs_src/generate_clients/tutorial001_py39.py!}
+ ```
+
+=== "Python 3.8+"
+
+ ```Python hl_lines="9-11 14-15 18 19 23"
+ {!> ../../../docs_src/generate_clients/tutorial001.py!}
+ ```
+
+่ฏทๆณจๆ๏ผ*่ทฏๅพๆไฝ* ๅฎไนไบไปไปฌๆ็จไบ่ฏทๆฑๆฐๆฎๅๅๅบๆฐๆฎ็ๆจกๅ๏ผๆไฝฟ็จ็ๆจกๅๆฏ`Item` ๅ `ResponseMessage`ใ
+
+### API ๆๆกฃ
+
+ๅฆๆๆจ่ฎฟ้ฎAPIๆๆกฃ๏ผๆจๅฐ็ๅฐๅฎๅ
ทๆๅจ่ฏทๆฑไธญๅ้ๅๅจๅๅบไธญๆฅๆถๆฐๆฎ็**ๆจกๅผ(schemas)**๏ผ
+
+
+
+ๆจๅฏไปฅ็ๅฐ่ฟไบๆจกๅผ๏ผๅ ไธบๅฎไปฌๆฏ็จ็จๅบไธญ็ๆจกๅๅฃฐๆ็ใ
+
+้ฃไบไฟกๆฏๅฏไปฅๅจๅบ็จ็ **OpenAPIๆจกๅผ** ่ขซๆพๅฐ๏ผ็ถๅๆพ็คบๅจAPIๆๆกฃไธญ๏ผ้่ฟSwagger UI๏ผใ
+
+OpenAPIไธญๆๅ
ๅซ็ๆจกๅ้ๆ็ธๅ็ไฟกๆฏๅฏไปฅ็จไบ **็ๆๅฎขๆท็ซฏไปฃ็ **ใ
+
+### ็ๆไธไธชTypeScript ๅฎขๆท็ซฏ
+
+็ฐๅจๆไปฌๆไบๅธฆๆๆจกๅ็ๅบ็จ๏ผๆไปฌๅฏไปฅไธบๅ็ซฏ็ๆๅฎขๆท็ซฏไปฃ็ ใ
+
+#### ๅฎ่ฃ
`openapi-typescript-codegen`
+
+ๆจๅฏไปฅไฝฟ็จไปฅไธๅทฅๅ
ทๅจๅ็ซฏไปฃ็ ไธญๅฎ่ฃ
`openapi-typescript-codegen`:
+
+
+
+ๆจ่ฟๅฐ่ชๅจ่กฅๅ
จ่ฆๅ้็ๆฐๆฎ๏ผ
+
+
+
+!!! tip
+ ่ฏทๆณจๆ๏ผ `name` ๅ `price` ็่ชๅจ่กฅๅ
จ๏ผๆฏ้่ฟๅ
ถๅจ`Item`ๆจกๅ(FastAPI)ไธญ็ๅฎไนๅฎ็ฐ็ใ
+
+ๅฆๆๅ้็ๆฐๆฎๅญๆฎตไธ็ฌฆ๏ผไฝ ไนไผ็ๅฐ็ผ่พๅจ็้่ฏฏๆ็คบ:
+
+
+
+ๅๅบ(response)ๅฏน่ฑกไนๆฅๆ่ชๅจ่กฅๅ
จ:
+
+
+
+## ๅธฆๆๆ ็ญพ็ FastAPI ๅบ็จ
+
+ๅจ่ฎธๅคๆ
ๅตไธ๏ผไฝ ็FastAPIๅบ็จ็จๅบไผๆดๅคๆ๏ผไฝ ๅฏ่ฝไผไฝฟ็จๆ ็ญพๆฅๅ้ไธๅ็ป็*่ทฏๅพๆไฝ(path operations)*ใ
+
+ไพๅฆ๏ผๆจๅฏไปฅๆไธไธช็จ `items` ็้จๅๅๅฆไธไธช็จไบ `users` ็้จๅ๏ผๅฎไปฌๅฏไปฅ็จๆ ็ญพๆฅๅ้๏ผ
+
+=== "Python 3.9+"
+
+ ```Python hl_lines="21 26 34"
+ {!> ../../../docs_src/generate_clients/tutorial002_py39.py!}
+ ```
+
+=== "Python 3.8+"
+
+ ```Python hl_lines="23 28 36"
+ {!> ../../../docs_src/generate_clients/tutorial002.py!}
+ ```
+
+### ็ๆๅธฆๆๆ ็ญพ็ TypeScript ๅฎขๆท็ซฏ
+
+ๅฆๆๆจไฝฟ็จๆ ็ญพไธบFastAPIๅบ็จ็ๆๅฎขๆท็ซฏ๏ผๅฎ้ๅธธไนไผๆ นๆฎๆ ็ญพๅๅฒๅฎขๆท็ซฏไปฃ็ ใ
+
+้่ฟ่ฟ็งๆนๅผ๏ผๆจๅฐ่ฝๅคไธบๅฎขๆท็ซฏไปฃ็ ่ฟ่กๆญฃ็กฎๅฐๆๅบๅๅ็ป๏ผ
+
+
+
+ๅจ่ฟไธชๆกไพไธญ๏ผๆจๆ๏ผ
+
+* `ItemsService`
+* `UsersService`
+
+### ๅฎขๆท็ซฏๆนๆณๅ็งฐ
+
+็ฐๅจ็ๆ็ๆนๆณๅๅ `createItemItemsPost` ็่ตทๆฅไธๅคช็ฎๆด:
+
+```TypeScript
+ItemsService.createItemItemsPost({name: "Plumbus", price: 5})
+```
+
+...่ฟๆฏๅ ไธบๅฎขๆท็ซฏ็ๆๅจไธบๆฏไธช *่ทฏๅพๆไฝ* ไฝฟ็จOpenAPI็ๅ
้จ **ๆไฝ ID(operation ID)**ใ
+
+OpenAPI่ฆๆฑๆฏไธชๆไฝ ID ๅจๆๆ *่ทฏๅพๆไฝ* ไธญ้ฝๆฏๅฏไธ็๏ผๅ ๆญค FastAPI ไฝฟ็จ**ๅฝๆฐๅ**ใ**่ทฏๅพ**ๅ**HTTPๆนๆณ/ๆไฝ**ๆฅ็ๆๆญคๆไฝID๏ผๅ ไธบ่ฟๆ ทๅฏไปฅ็กฎไฟ่ฟไบๆไฝ ID ๆฏๅฏไธ็ใ
+
+ไฝๆฅไธๆฅๆไผๅ่ฏไฝ ๅฆไฝๆน่ฟใ ๐ค
+
+## ่ชๅฎไนๆไฝIDๅๆดๅฅฝ็ๆนๆณๅ
+
+ๆจๅฏไปฅ**ไฟฎๆน**่ฟไบๆไฝID็**็ๆ**ๆนๅผ๏ผไปฅไฝฟๅ
ถๆด็ฎๆด๏ผๅนถๅจๅฎขๆท็ซฏไธญๅ
ทๆ**ๆด็ฎๆด็ๆนๆณๅ็งฐ**ใ
+
+ๅจ่ฟ็งๆ
ๅตไธ๏ผๆจๅฟ
้กป็กฎไฟๆฏไธชๆไฝIDๅจๅ
ถไปๆน้ขๆฏ**ๅฏไธ**็ใ
+
+ไพๅฆ๏ผๆจๅฏไปฅ็กฎไฟๆฏไธช*่ทฏๅพๆไฝ*้ฝๆไธไธชๆ ็ญพ๏ผ็ถๅๆ นๆฎ**ๆ ็ญพ**ๅ*่ทฏๅพๆไฝ***ๅ็งฐ**๏ผๅฝๆฐๅ๏ผๆฅ็ๆๆไฝIDใ
+
+### ่ชๅฎไน็ๆๅฏไธIDๅฝๆฐ
+
+FastAPIไธบๆฏไธช*่ทฏๅพๆไฝ*ไฝฟ็จไธไธช**ๅฏไธID**๏ผๅฎ็จไบ**ๆไฝID**๏ผไน็จไบไปปไฝๆ้่ชๅฎไนๆจกๅ็ๅ็งฐ๏ผ็จไบ่ฏทๆฑๆๅๅบใ
+
+ไฝ ๅฏไปฅ่ชๅฎไน่ฏฅๅฝๆฐใๅฎๆฅๅไธไธช `APIRoute` ๅฏน่ฑกไฝไธบ่พๅ
ฅ๏ผๅนถ่พๅบไธไธชๅญ็ฌฆไธฒใ
+
+ไพๅฆ๏ผไปฅไธๆฏไธไธช็คบไพ๏ผๅฎไฝฟ็จ็ฌฌไธไธชๆ ็ญพ๏ผไฝ ๅฏ่ฝๅชๆไธไธชๆ ็ญพ๏ผๅ*่ทฏๅพๆไฝ*ๅ็งฐ๏ผๅฝๆฐๅ๏ผใ
+
+็ถๅ๏ผไฝ ๅฏไปฅๅฐ่ฟไธช่ชๅฎไนๅฝๆฐไฝไธบ `generate_unique_id_function` ๅๆฐไผ ้็ป **FastAPI**:
+
+=== "Python 3.9+"
+
+ ```Python hl_lines="6-7 10"
+ {!> ../../../docs_src/generate_clients/tutorial003_py39.py!}
+ ```
+
+=== "Python 3.8+"
+
+ ```Python hl_lines="8-9 12"
+ {!> ../../../docs_src/generate_clients/tutorial003.py!}
+ ```
+
+### ไฝฟ็จ่ชๅฎไนๆไฝID็ๆTypeScriptๅฎขๆท็ซฏ
+
+็ฐๅจ๏ผๅฆๆไฝ ๅๆฌก็ๆๅฎขๆท็ซฏ๏ผไฝ ไผๅ็ฐๅฎๅ
ทๆๆนๅ็ๆนๆณๅ็งฐ๏ผ
+
+
+
+ๆญฃๅฆไฝ ๆ่ง๏ผ็ฐๅจๆนๆณๅ็งฐไธญๅชๅ
ๅซๆ ็ญพๅๅฝๆฐๅ๏ผไธๅๅ
ๅซURL่ทฏๅพๅHTTPๆไฝ็ไฟกๆฏใ
+
+### ้ขๅค็็จไบๅฎขๆท็ซฏ็ๆๅจ็OpenAPI่ง่
+
+็ๆ็ไปฃ็ ไป็ถๅญๅจไธไบ**้ๅค็ไฟกๆฏ**ใ
+
+ๆไปฌๅทฒ็ป็ฅ้่ฏฅๆนๆณไธ **items** ็ธๅ
ณ๏ผๅ ไธบๅฎๅจ `ItemsService` ไธญ๏ผไปๆ ็ญพไธญ่ทๅ๏ผ๏ผไฝๆนๆณๅไธญไป็ถๆๆ ็ญพๅไฝไธบๅ็ผใ๐
+
+ไธ่ฌๆ
ๅตไธๅฏนไบOpenAPI๏ผๆไปฌๅฏ่ฝไป็ถๅธๆไฟ็ๅฎ๏ผๅ ไธบ่ฟๅฐ็กฎไฟๆไฝIDๆฏ**ๅฏไธ็**ใ
+
+ไฝๅฏนไบ็ๆ็ๅฎขๆท็ซฏ๏ผๆไปฌๅฏไปฅๅจ็ๆๅฎขๆท็ซฏไนๅ**ไฟฎๆน** OpenAPI ๆไฝID๏ผไปฅไฝฟๆนๆณๅ็งฐๆดๅ ็พ่งๅ**็ฎๆด**ใ
+
+ๆไปฌๅฏไปฅๅฐ OpenAPI JSON ไธ่ฝฝๅฐไธไธชๅไธบ`openapi.json`็ๆไปถไธญ๏ผ็ถๅไฝฟ็จไปฅไธ่ๆฌ**ๅ ้คๆญคๅ็ผ็ๆ ็ญพ**๏ผ
+
+```Python
+{!../../../docs_src/generate_clients/tutorial004.py!}
+```
+
+้่ฟ่ฟๆ ทๅ๏ผๆไฝIDๅฐไป็ฑปไผผไบ `items-get_items` ็ๅ็งฐ้ๅฝๅไธบ `get_items` ๏ผ่ฟๆ ทๅฎขๆท็ซฏ็ๆๅจๅฐฑๅฏไปฅ็ๆๆด็ฎๆด็ๆนๆณๅ็งฐใ
+
+### ไฝฟ็จ้ขๅค็็OpenAPI็ๆTypeScriptๅฎขๆท็ซฏ
+
+็ฐๅจ๏ผ็ฑไบๆ็ป็ปๆไฟๅญๅจๆไปถopenapi.jsonไธญ๏ผไฝ ๅฏไปฅไฟฎๆน package.json ๆไปถไปฅไฝฟ็จๆญคๆฌๅฐๆไปถ๏ผไพๅฆ๏ผ
+
+```JSON hl_lines="7"
+{
+ "name": "frontend-app",
+ "version": "1.0.0",
+ "description": "",
+ "main": "index.js",
+ "scripts": {
+ "generate-client": "openapi --input ./openapi.json --output ./src/client --client axios"
+ },
+ "author": "",
+ "license": "",
+ "devDependencies": {
+ "openapi-typescript-codegen": "^0.20.1",
+ "typescript": "^4.6.2"
+ }
+}
+```
+
+็ๆๆฐ็ๅฎขๆท็ซฏไนๅ๏ผไฝ ็ฐๅจๅฐๆฅๆ**ๆธ
ๆฐ็ๆนๆณๅ็งฐ**๏ผๅ
ทๅค**่ชๅจ่กฅๅ
จ**ใ**้่ฏฏๆ็คบ**็ญๅ่ฝ๏ผ
+
+
+
+## ไผ็น
+
+ๅฝไฝฟ็จ่ชๅจ็ๆ็ๅฎขๆท็ซฏๆถ๏ผไฝ ๅฐ่ทๅพไปฅไธ็่ชๅจ่กฅๅ
จๅ่ฝ๏ผ
+
+* ๆนๆณใ
+* ่ฏทๆฑไฝไธญ็ๆฐๆฎใๆฅ่ฏขๅๆฐ็ญใ
+* ๅๅบๆฐๆฎใ
+
+ไฝ ่ฟๅฐ่ทๅพ้ๅฏนๆๆๅ
ๅฎน็้่ฏฏๆ็คบใ
+
+ๆฏๅฝไฝ ๆดๆฐๅ็ซฏไปฃ็ ๅนถ**้ๆฐ็ๆ**ๅ็ซฏไปฃ็ ๆถ๏ผๆฐ็*่ทฏๅพๆไฝ*ๅฐไฝไธบๆนๆณๅฏ็จ๏ผๆง็ๆนๆณๅฐ่ขซๅ ้ค๏ผๅนถไธๅ
ถไปไปปไฝๆดๆนๅฐๅๆ ๅจ็ๆ็ไปฃ็ ไธญใ ๐ค
+
+่ฟไนๆๅณ็ๅฆๆๆไปปไฝๆดๆน๏ผๅฎๅฐ่ชๅจ**ๅๆ **ๅจๅฎขๆท็ซฏไปฃ็ ไธญใๅฆๆไฝ **ๆๅปบ**ๅฎขๆท็ซฏ๏ผๅจไฝฟ็จ็ๆฐๆฎไธๅญๅจ**ไธๅน้
**ๆถ๏ผๅฎๅฐๆฅ้ใ
+
+ๅ ๆญค๏ผไฝ ๅฐๅจๅผๅๅจๆ็ๆฉๆ**ๆฃๆตๅฐ่ฎธๅค้่ฏฏ**๏ผ่ไธๅฟ
็ญๅพ
้่ฏฏๅจ็ไบง็ฏๅขไธญๅๆ็ป็จๆทๅฑ็คบ๏ผ็ถๅๅฐ่ฏ่ฐ่ฏ้ฎ้ขๆๅจใ โจ
diff --git a/docs/zh/docs/advanced/settings.md b/docs/zh/docs/advanced/settings.md
index 597e99a77..7f718acef 100644
--- a/docs/zh/docs/advanced/settings.md
+++ b/docs/zh/docs/advanced/settings.md
@@ -223,13 +223,13 @@ $ ADMIN_EMAIL="deadpool@example.com" APP_NAME="ChimichangApp"uvicorn main:app
{!> ../../../docs_src/settings/app02_an_py39/main.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="6 12-13"
{!> ../../../docs_src/settings/app02_an/main.py!}
```
-=== "Python 3.6+ ้ๆณจ่งฃ็ๆฌ"
+=== "Python 3.8+ ้ๆณจ่งฃ็ๆฌ"
!!! tip
ๅฆๆๅฏ่ฝ๏ผ่ฏทๅฐฝ้ไฝฟ็จ `Annotated` ็ๆฌใ
@@ -251,13 +251,13 @@ $ ADMIN_EMAIL="deadpool@example.com" APP_NAME="ChimichangApp"uvicorn main:app
{!> ../../../docs_src/settings/app02_an_py39/main.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="17 19-21"
{!> ../../../docs_src/settings/app02_an/main.py!}
```
-=== "Python 3.6+ ้ๆณจ่งฃ็ๆฌ"
+=== "Python 3.8+ ้ๆณจ่งฃ็ๆฌ"
!!! tip
ๅฆๆๅฏ่ฝ๏ผ่ฏทๅฐฝ้ไฝฟ็จ `Annotated` ็ๆฌใ
@@ -345,13 +345,13 @@ def get_settings():
{!> ../../../docs_src/settings/app03_an_py39/main.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="1 11"
{!> ../../../docs_src/settings/app03_an/main.py!}
```
-=== "Python 3.6+ ้ๆณจ่งฃ็ๆฌ"
+=== "Python 3.8+ ้ๆณจ่งฃ็ๆฌ"
!!! tip
ๅฆๆๅฏ่ฝ๏ผ่ฏทๅฐฝ้ไฝฟ็จ `Annotated` ็ๆฌใ
diff --git a/docs/zh/docs/advanced/websockets.md b/docs/zh/docs/advanced/websockets.md
index a723487fd..a5cbdd965 100644
--- a/docs/zh/docs/advanced/websockets.md
+++ b/docs/zh/docs/advanced/websockets.md
@@ -118,7 +118,7 @@ $ uvicorn main:app --reload
{!> ../../../docs_src/websockets/tutorial002_an_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="69-70 83"
{!> ../../../docs_src/websockets/tutorial002_an.py!}
@@ -133,7 +133,7 @@ $ uvicorn main:app --reload
{!> ../../../docs_src/websockets/tutorial002_py310.py!}
```
-=== "Python 3.6+ ้ๅธฆๆณจ่งฃ็ๆฌ"
+=== "Python 3.8+ ้ๅธฆๆณจ่งฃ็ๆฌ"
!!! tip
ๅฆๆๅฏ่ฝ๏ผ่ฏทๅฐฝ้ไฝฟ็จ `Annotated` ็ๆฌใ
@@ -181,7 +181,7 @@ $ uvicorn main:app --reload
{!> ../../../docs_src/websockets/tutorial003_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="81-83"
{!> ../../../docs_src/websockets/tutorial003.py!}
diff --git a/docs/zh/docs/async.md b/docs/zh/docs/async.md
new file mode 100644
index 000000000..7cc76fc86
--- /dev/null
+++ b/docs/zh/docs/async.md
@@ -0,0 +1,430 @@
+# ๅนถๅ async / await
+
+ๆๅ
ณ่ทฏๅพๆไฝๅฝๆฐ็ `async def` ่ฏญๆณไปฅๅๅผๆญฅไปฃ็ ใๅนถๅๅๅนถ่ก็ไธไบ่ๆฏ็ฅ่ฏใ
+
+## ่ตถๆถ้ดๅ๏ผ
+
+TL;DR:
+
+ๅฆๆไฝ ๆญฃๅจไฝฟ็จ็ฌฌไธๆนๅบ๏ผๅฎไปฌไผๅ่ฏไฝ ไฝฟ็จ `await` ๅ
ณ้ฎๅญๆฅ่ฐ็จๅฎไปฌ๏ผๅฐฑๅ่ฟๆ ท๏ผ
+
+```Python
+results = await some_library()
+```
+
+็ถๅ๏ผ้่ฟ `async def` ๅฃฐๆไฝ ็ *่ทฏๅพๆไฝๅฝๆฐ*๏ผ
+
+```Python hl_lines="2"
+@app.get('/')
+async def read_results():
+ results = await some_library()
+ return results
+```
+
+!!! note
+ ไฝ ๅช่ฝๅจ่ขซ `async def` ๅๅปบ็ๅฝๆฐๅ
ไฝฟ็จ `await`
+
+---
+
+ๅฆๆไฝ ๆญฃๅจไฝฟ็จไธไธช็ฌฌไธๆนๅบๅๆไบ็ปไปถ๏ผๆฏๅฆ๏ผๆฐๆฎๅบใAPIใๆไปถ็ณป็ป...๏ผ่ฟ่ก้ไฟก๏ผ็ฌฌไธๆนๅบๅไธๆฏๆไฝฟ็จ `await` ๏ผ็ฎๅๅคงๅคๆฐๆฐๆฎๅบไธๆนๅบ้ฝๆฏ่ฟๆ ท๏ผ๏ผ่ฟ็งๆ
ๅตไฝ ๅฏไปฅๅๅนณๅธธ้ฃๆ ทไฝฟ็จ `def` ๅฃฐๆไธไธช่ทฏๅพๆไฝๅฝๆฐ๏ผๅฐฑๅ่ฟๆ ท๏ผ
+
+```Python hl_lines="2"
+@app.get('/')
+def results():
+ results = some_library()
+ return results
+```
+
+---
+
+ๅฆๆไฝ ็ๅบ็จ็จๅบไธ้่ฆไธๅ
ถไปไปปไฝไธ่ฅฟ้ไฟก่็ญๅพ
ๅ
ถๅๅบ๏ผ่ฏทไฝฟ็จ `async def`ใ
+
+---
+
+ๅฆๆไฝ ไธๆธ
ๆฅ๏ผไฝฟ็จ `def` ๅฐฑๅฅฝ.
+
+---
+
+**ๆณจๆ**๏ผไฝ ๅฏไปฅๆ นๆฎ้่ฆๅจ่ทฏๅพๆไฝๅฝๆฐไธญๆททๅไฝฟ็จ `def` ๅ `async def`๏ผๅนถไฝฟ็จๆ้ๅไฝ ็ๆนๅผๅปๅฎไนๆฏไธชๅฝๆฐใFastAPI ๅฐไธบไปไปฌๅๆญฃ็กฎ็ไบๆ
ใ
+
+ๆ ่ฎบๅฆไฝ๏ผๅจไธ่ฟฐไปปไฝๆ
ๅตไธ๏ผFastAPI ไปๅฐๅผๆญฅๅทฅไฝ๏ผ้ๅบฆไน้ๅธธๅฟซใ
+
+ไฝๆฏ๏ผ้่ฟ้ตๅพชไธ่ฟฐๆญฅ้ชค๏ผๅฎๅฐ่ฝๅค่ฟ่กไธไบๆง่ฝไผๅใ
+
+## ๆๆฏ็ป่
+
+Python ็็ฐไปฃ็ๆฌๆฏๆ้่ฟไธ็งๅซ**"ๅ็จ"**โโไฝฟ็จ `async` ๅ `await` ่ฏญๆณ็ไธ่ฅฟๆฅๅ**โๅผๆญฅไปฃ็ โ**ใ
+
+่ฎฉๆไปฌๅจไธ้ข็้จๅไธญ้ไธไป็ป๏ผ
+
+* **ๅผๆญฅไปฃ็ **
+* **`async` ๅ `await`**
+* **ๅ็จ**
+
+## ๅผๆญฅไปฃ็
+
+ๅผๆญฅไปฃ็ ไป
ไป
ๆๅณ็็ผ็จ่ฏญ่จ ๐ฌ ๆๅๆณๅ่ฏ่ฎก็ฎๆบ/็จๅบ ๐ค ๅจไปฃ็ ไธญ็ๆไธช็น๏ผๅฎ ๐ค ๅฐไธๅพไธ็ญๅพ
ๅจๆไบๅฐๆนๅฎๆไธไบไบๆ
ใ่ฎฉๆไปฌๅ่ฎพไธไบไบๆ
่ขซ็งฐไธบ "ๆ
ขๆไปถ"๐.
+
+ๆไปฅ๏ผๅจ็ญๅพ
"ๆ
ขๆไปถ"๐ๅฎๆ็่ฟๆฎตๆถ้ด๏ผ่ฎก็ฎๆบๅฏไปฅๅไธไบๅ
ถไปๅทฅไฝใ
+
+็ถๅ่ฎก็ฎๆบ/็จๅบ ๐ค ๆฏๆฌกๆๆบไผ้ฝไผๅๆฅ๏ผๅ ไธบๅฎๅๅจ็ญๅพ
๏ผๆ่
ๅฎ ๐ค ๅฎๆไบๅฝๅๆๆ็ๅทฅไฝใ่ไธๅฎ ๐ค ๅฐๆฅ็ๅฎ็ญๅพ
็ๆๆไปปๅกไธญๆฏๅฆๆๅทฒ็ปๅฎๆ็๏ผๅๅฎๅฟ
้กปๅ็ไปปไฝไบๆ
ใ
+
+ๆฅไธๆฅ๏ผๅฎ ๐ค ๅฎๆ็ฌฌไธไธชไปปๅก๏ผๆฏๅฆๆฏๆไปฌ็"ๆ
ขๆไปถ"๐) ๅนถ็ปง็ปญไธไน็ธๅ
ณ็ไธๅใ
+
+่ฟไธช"็ญๅพ
ๅ
ถไปไบๆ
"้ๅธธๆ็ๆฏไธไบ็ธๅฏน่พๆ
ข๏ผไธๅค็ๅจๅ RAM ๅญๅจๅจ็้ๅบฆ็ธๆฏ๏ผ็ I/O ๆไฝ๏ผๆฏๅฆ่ฏด๏ผ
+
+* ้่ฟ็ฝ็ปๅ้ๆฅ่ชๅฎขๆท็ซฏ็ๆฐๆฎ
+* ๅฎขๆท็ซฏๆฅๆถๆฅ่ช็ฝ็ปไธญ็ๆฐๆฎ
+* ็ฃ็ไธญ่ฆ็ฑ็ณป็ป่ฏปๅๅนถๆไพ็ป็จๅบ็ๆไปถ็ๅ
ๅฎน
+* ็จๅบๆไพ็ป็ณป็ป็่ฆๅๅ
ฅ็ฃ็็ๅ
ๅฎน
+* ไธไธช API ็่ฟ็จ่ฐ็จ
+* ไธไธชๆฐๆฎๅบๆไฝ๏ผ็ดๅฐๅฎๆ
+* ไธไธชๆฐๆฎๅบๆฅ่ฏข๏ผ็ดๅฐ่ฟๅ็ปๆ
+* ็ญ็ญ.
+
+่ฟไธชๆง่ก็ๆถ้ดๅคงๅคๆฏๅจ็ญๅพ
I/O ๆไฝ๏ผๅ ๆญคๅฎไปฌ่ขซๅซๅ "I/O ๅฏ้ๅ" ๆไฝใ
+
+ๅฎ่ขซ็งฐไธบ"ๅผๆญฅ"็ๅๅ ๆฏๅ ไธบ่ฎก็ฎๆบ/็จๅบไธๅฟ
ไธๆ
ขไปปๅก"ๅๆญฅ"๏ผๅป็ญๅพ
ไปปๅกๅฎๆ็็กฎๅๆถๅป๏ผ่ๅจๆญคๆ้ดไธๅไปปไฝไบๆ
็ดๅฐ่ฝๅค่ทๅไปปๅก็ปๆๆ็ปง็ปญๅทฅไฝใ
+
+็ธๅ๏ผไฝไธบไธไธช"ๅผๆญฅ"็ณป็ป๏ผไธๆฆๅฎๆ๏ผไปปๅกๅฐฑๅฏไปฅๆ้็ญๅพ
ไธๆฎตๆถ้ด๏ผๅ ๅพฎ็ง๏ผ๏ผ็ญๅพ
่ฎก็ฎๆบ็จๅบๅฎๆๅฎ่ฆๅ็ไปปไฝไบๆ
๏ผ็ถๅๅๆฅ่ทๅ็ปๆๅนถ็ปง็ปญๅค็ๅฎไปฌใ
+
+ๅฏนไบ"ๅๆญฅ"๏ผไธ"ๅผๆญฅ"็ธๅ๏ผ๏ผไปไปฌ้ๅธธไนไฝฟ็จ"้กบๅบ"ไธ่ฏ๏ผๅ ไธบ่ฎก็ฎๆบ็จๅบๅจๅๆขๅฐๅฆไธไธชไปปๅกไนๅๆฏๆ้กบๅบๆง่กๆๆๆญฅ้ชค๏ผๅณไฝฟ่ฟไบๆญฅ้ชคๆถๅๅฐ็ญๅพ
ใ
+
+### ๅนถๅไธๆฑๅ ก
+
+ไธ่ฟฐๅผๆญฅไปฃ็ ็ๆๆณๆๆถไน่ขซ็งฐไธบโๅนถๅโ๏ผๅฎไธๅไบโๅนถ่กโใ
+
+ๅนถๅๅๅนถ่ก้ฝไธโไธๅ็ไบๆ
ๆๅคๆๅฐๅๆถๅ็โๆๅ
ณใ
+
+ไฝๆฏๅนถๅๅๅนถ่กไน้ด็็ป่ๆฏๅฎๅ
จไธๅ็ใ
+
+่ฆไบ่งฃๅทฎๅผ๏ผ่ฏทๆณ่ฑกไปฅไธๅ
ณไบๆฑๅ ก็ๆ
ไบ๏ผ
+
+### ๅนถๅๆฑๅ ก
+
+ไฝ ๅไฝ ็ๆไบบไธ่ตทๅปๅฟซ้คๅบ๏ผไฝ ๆ้ๅจๅ้ข๏ผๆถ้ถๅไปไฝ ๅ้ข็ไบบๆฅๅใ๐
+
+
+
+็ถๅ่ฝฎๅฐไฝ ไบ๏ผไฝ ไธบไฝ ็ๆไบบๅไฝ ้ไบไธคไธช้ๅธธ่ฑชๅ็ๆฑๅ กใ๐๐
+
+
+
+ๆถ้ถๅๅฏนๅจๆฟ้็ๅจๅธ่ฏดไบไธไบ่ฏ๏ผ่ฎฉไปไปฌ็ฅ้ไปไปฌๅฟ
้กปไธบไฝ ๅๅคๆฑๅ ก๏ผๅฐฝ็ฎกไปไปฌ็ฎๅๆญฃๅจไธบไนๅ็้กพๅฎขๅๅคๆฑๅ ก๏ผใ
+
+
+
+ไฝ ไป้ฑไบใ ๐ธ
+
+ๆถ้ถๅ็ปไฝ ่ฝฎๅฐ็ๅท็ ใ
+
+
+
+ๅฝไฝ ๅจ็ญๅพ
็ๆถๅ๏ผไฝ ๅไฝ ็ๆไบบไธ่ตทๅปๆ้ไธๅผ ๆกๅญ๏ผ็ถๅไฝ ไปฌๅไธๆฅ่ไบๅพ้ฟๆถ้ด๏ผๅ ไธบๆฑๅ กๅพ่ฑชๅ๏ผ้่ฆไธไบๆถ้ดๆฅๅๅค๏ผใ
+
+ๅฝไฝ ๅไฝ ็ๆไบบๅๅจๆกๅญๆ๏ผ็ญๅพ
ๆฑๅ ก็ๆถๅ๏ผไฝ ๅฏไปฅ็จ่ฟๆฎตๆถ้ดๆฅๆฌฃ่ตไฝ ็ๆไบบๆฏๅคไน็ๆฃใๅฏ็ฑๅ่ชๆโจ๐โจใ
+
+
+
+ๅจ็ญๅพ
ไธญๅไฝ ็ๆไบบไบค่ฐๆถ๏ผไฝ ไผไธๆถๅฐๆฅ็ๆๅฐไธๆพ็คบ็ๅท็ ๏ผ็็ๆฏๅฆๅทฒ็ป่ฝฎๅฐไฝ ไบใ
+
+็ถๅๅจๆไธชๆถๅป๏ผ็ปไบ่ฝฎๅฐไฝ ไบใไฝ ๅปๆๅฐๆฟๆฑๅ ก็ถๅๅๅฐๆกๅญไธใ
+
+
+
+ไฝ ไปฌไบซ็จไบๆฑๅ ก๏ผๆดไธช่ฟ็จ้ฝๅพๅผๅฟใโจ
+
+
+
+!!! info
+ ๆผไบฎ็ๆ็ปๆฅ่ช Ketrina Thompson. ๐จ
+
+---
+
+ๅจ้ฃไธชๆ
ไบ้๏ผๅ่ฎพไฝ ๆฏ่ฎก็ฎๆบ็จๅบ ๐ค ใ
+
+ๅฝไฝ ๅจๆ้ๆถ๏ผไฝ ๅชๆฏ้ฒ็๐ด๏ผ ่ฝฎๅฐไฝ ๅไธๅไปปไฝไบๆ
๏ผไป
ๆ้๏ผใไฝๆ้ๅพๅฟซ๏ผๅ ไธบๆถ้ถๅๅชๆฅ่ฎขๅ๏ผไธๅๅค่ฎขๅ๏ผ๏ผๆไปฅ่ฟไธๅ้ฝ่ฟๅฅฝใ
+
+็ถๅ๏ผๅฝ่ฝฎๅฐไฝ ๆถ๏ผ้่ฆไฝ ๅไธไบๅฎ้
ๆง็ๅทฅไฝ๏ผๆฏๅฆๆฅ็่ๅ๏ผๅณๅฎไฝ ๆณ่ฆไปไน๏ผ่ฎฉไฝ ็ๆไบบ้ๆฉ๏ผๆฏไป๏ผๆฃๆฅไฝ ๆฏๅฆๆไพไบๆญฃ็กฎ็่ดฆๅๆๅก๏ผๆฃๆฅไฝ ็ๆถ่ดนๆฏๅฆๆญฃ็กฎ๏ผๆฃๆฅ่ฎขๅๆฏๅฆๆๆญฃ็กฎ็้กน็ฎ๏ผ็ญ็ญใ
+
+ๆญคๆถ๏ผๅณไฝฟไฝ ไป็ถๆฒกๆๆฑๅ ก๏ผไฝ ๅๆถ้ถๅ็ๅทฅไฝไน"ๆๅ"ไบโธ๏ผ ๅ ไธบไฝ ๅฟ
้กป็ญๅพ
ไธๆฎตๆถ้ด ๐ ่ฎฉไฝ ็ๆฑๅ กๅๅฅฝใ
+
+ไฝๆฏ๏ผๅฝไฝ ็ฆปๅผๆๅฐๅนถๅๅจๆกๅญๆ๏ผๅจ่ฝฎๅฐไฝ ็ๅท็ ๅ็่ฟๆฎตๆถ้ด๏ผไฝ ๅฏไปฅๅฐ็ฆ็นๅๆขๅฐ ๐ ไฝ ็ๆไบบไธ๏ผๅนถๅไธไบ"ๅทฅไฝ"โฏ ๐คใไฝ ๅฏไปฅๅไธไบ้ๅธธ"ๆๆๆ"็ไบๆ
๏ผๆฏๅฆๅไฝ ็ๆไบบ่ฐๆ
๐.
+
+ไนๅ๏ผๆถ้ถๅ ๐ ๆๅท็ ๆพ็คบๅจๆพ็คบๅฑไธ๏ผๅนถ่ฏดๅฐ "ๆฑๅ กๅๅฅฝไบ"๏ผ่ๅฝๆพ็คบ็ๅท็ ๆฏไฝ ็ๅท็ ๆถ๏ผไฝ ไธไผ็ซๅป็ฏ็ๅฐ่ทณ่ตทๆฅใๅ ไธบไฝ ็ฅ้ๆฒกๆไบบไผๅทไฝ ็ๆฑๅ ก๏ผๅ ไธบไฝ ๆไฝ ็ๅท็ ๏ผ่ๅ
ถไปไบบๅๆไปไปฌ่ชๅทฑ็ๅท็ ใ
+
+ๆไปฅไฝ ่ฆ็ญๅพ
ไฝ ็ๆไบบๅฎๆๆ
ไบ๏ผๅฎๆๅฝๅ็ๅทฅไฝโฏ /ๆญฃๅจๅ็ไบ๐ค)๏ผ ่ฝป่ฝปๅพฎ็ฌ๏ผ่ฏดไฝ ่ฆๅๆฑๅ กโธ.
+
+็ถๅไฝ ๅปๆๅฐ๐๏ผ ๅฐ็ฐๅจๅๅงไปปๅกๅทฒ็ปๅฎๆโฏ๏ผ ๆฟ่ตทๆฑๅ ก๏ผ่ฏดๅฃฐ่ฐข่ฐข๏ผ็ถๅๆๅฎไปฌ้ๅฐๆกไธใ่ฟๅฐฑๅฎๆไบไธ่ฎกๆฐๅจไบคไบ็ๆญฅ้ชค/ไปปๅกโน. ่ฟๅ่ฟๆฅๅไบง็ไบไธ้กนๆฐไปปๅก๏ผๅณ"ๅๆฑๅ ก"๐ โฏ๏ผ ไธไธไธช"ๆฟๆฑๅ ก"็ไปปๅกๅทฒ็ป็ปๆไบโน.
+
+### ๅนถ่กๆฑๅ ก
+
+็ฐๅจ่ฎฉๆไปฌๅ่ฎพไธๆฏ"ๅนถๅๆฑๅ ก"๏ผ่ๆฏ"ๅนถ่กๆฑๅ ก"ใ
+
+ไฝ ๅไฝ ็ๆไบบไธ่ตทๅปๅๅนถ่กๅฟซ้คใ
+
+ไฝ ็ซๅจ้ไผไธญ๏ผๅๆถๆฏๅจๅธ็ๅ ไธชๆถ้ถๅ๏ผๆฏๆน่ฏด8ไธช๏ผไปๅ้ข็ไบบ้ฃ้ๆฅๅใ
+
+ไฝ ไนๅ็ๆฏไธชไบบ้ฝๅจ็ญๅพ
ไปไปฌ็ๆฑๅ กๅๅคๅฅฝๅๆ็ฆปๅผๆๅฐ๏ผๅ ไธบ8ๅๆถ้ถๅ้ฝไผๅจไธไธไปฝ่ฎขๅๅ้ฉฌไธๅๅคๅฅฝๆฑๅ กใ
+
+
+
+็ถๅ๏ผ็ปไบ่ฝฎๅฐไฝ ไบ๏ผไฝ ไธบไฝ ็ๆไบบๅไฝ ่ฎข่ดญไบไธคไธช้ๅธธ็ฒพ็พ็ๆฑๅ กใ
+
+ไฝ ไป้ฑไบ ๐ธใ
+
+
+
+ๆถ้ถๅๅปๅจๆฟใ
+
+ไฝ ็ซๅจๆๅฐๅ ๐็ญๅพ
็๏ผ่ฟๆ ทๅฐฑไธไผๆไบบๅจไฝ ไนๅๆข่ตฐไฝ ็ๆฑๅ ก๏ผๅ ไธบๆฒกๆ่ฝฎๆต็ๅท็ ใ
+
+
+
+ๅฝไฝ ๅไฝ ็ๆไบบๅฟไบไธ่ฎฉไปปไฝไบบๅบ็ฐๅจไฝ ้ขๅ๏ผๅนถไธๅจไปไปฌๅฐๆฅ็ๆถๅๆฟ่ตฐไฝ ็ๆฑๅ กๆถ๏ผไฝ ๆ ๆณๅ
ณๆณจๅฐไฝ ็ๆไบบใ๐
+
+่ฟๆฏ"ๅๆญฅ"็ๅทฅไฝ๏ผไฝ ่ขซ่ฟซไธๆๅกๅ/ๅจๅธ ๐จโ๐ณ"ๅๆญฅ"ใไฝ ๅจๆญคๅฟ
้กป็ญๅพ
๐ ๏ผๅจๆถ้ถๅ/ๅจๅธ ๐จโ๐ณ ๅฎๆๆฑๅ กๅนถๅฐๅฎไปฌไบค็ปไฝ ็็กฎๅๆถ้ดๅฐ่พพไนๅไธ็ด็ญๅพ
๏ผๅฆๅๅ
ถไปไบบๅฏ่ฝไผๆฟ่ตฐๅฎไปฌใ
+
+
+
+ไฝ ็ป่ฟ้ฟๆถ้ด็็ญๅพ
๐ ๏ผๆถ้ถๅ/ๅจๅธ ๐จโ๐ณ็ปไบๅธฆ็ๆฑๅ กๅๅฐไบๆๅฐใ
+
+
+
+ไฝ ๆฟ็ๆฑๅ ก๏ผๅไฝ ็ๆ
ไบบไธ่ตทไธๆกใ
+
+ไฝ ไปฌไป
ไป
ๆฏๅไบๅฎไปฌ๏ผๅฐฑ็ปๆไบใโน
+
+
+
+ๆฒกๆๅคชๅค็ไบค่ฐๆ่ฐๆ
๏ผๅ ไธบๅคง้จๅๆถ้ด ๐ ้ฝๅจๆๅฐๅ็ญๅพ
๐ใ
+
+!!! info
+ ๆผไบฎ็ๆ็ปๆฅ่ช Ketrina Thompson. ๐จ
+
+---
+
+ๅจ่ฟไธชๅนถ่กๆฑๅ ก็ๅบๆฏไธญ๏ผไฝ ๆฏไธไธช่ฎก็ฎๆบ็จๅบ ๐ค ไธๆไธคไธชๅค็ๅจ๏ผไฝ ๅไฝ ็ๆไบบ๏ผ๏ผ้ฝๅจ็ญๅพ
๐ ๏ผๅนถๆๅ
ฅไปไปฌ็ๆณจๆๅ โฏ ๅจๆๅฐไธ็ญๅพ
ไบๅพ้ฟไธๆฎตๆถ้ดใ
+
+่ฟๅฎถๅฟซ้คๅบๆ 8 ไธชๅค็ๅจ๏ผๆถ้ถๅ/ๅจๅธ๏ผใ่ๅนถๅๆฑๅ กๅบๅฏ่ฝๅชๆ 2 ไธช๏ผไธไธชๆถ้ถๅๅไธไธชๅจๅธ๏ผใ
+
+ไฝๆ็ป็ไฝ้ชไป็ถไธๆฏๆๅฅฝ็ใ๐
+
+---
+
+่ฟๅฐๆฏไธๆฑๅ ก็็ฑปไผผๆ
ไบใ๐
+
+ไธ็งๆด"่ดด่ฟ็ๆดป"็ไพๅญ๏ผๆณ่ฑกไธๅฎถ้ถ่กใ
+
+็ดๅฐๆ่ฟ๏ผๅคงๅคๆฐ้ถ่ก้ฝๆๅคไธชๅบ็บณๅ ๐จโ๐ผ๐จโ๐ผ๐จโ๐ผ๐จโ๐ผ ่ฟๆไธๆก้ฟ้ฟๆ้้ไผ๐๐๐๐๐๐๐๐ใ
+
+ๆๆๆถ้ถๅ้ฝๆฏไธไธชๆฅไธไธช็ๅจๅฎขๆท้ขๅๅๅฎๆๆ็ๅทฅไฝ๐จโ๐ผโฏ.
+
+ไฝ ๅฟ
้กป็ป่ฟ ๐ ่พ้ฟๆถ้ดๆ้๏ผๅฆๅไฝ ๅฐฑๆฒกๆบไผไบใ
+
+ไฝ ๅฏไธไผๆณๅธฆไฝ ็ๆไบบ ๐ ๅไฝ ไธ่ตทๅป้ถ่กๅไบ๐ฆ.
+
+### ๆฑๅ ก็ป่ฎบ
+
+ๅจ"ไฝ ไธๆไบบไธ่ตทๅๆฑๅ ก"็่ฟไธชๅบๆฏไธญ๏ผๅ ไธบๆๅพๅคไบบๅจ็ญๅพ
๐๏ผ ไฝฟ็จๅนถๅ็ณป็ปๆดๆๆไนโธ๐โฏ.
+
+ๅคงๅคๆฐ Web ๅบ็จ้ฝๆฏ่ฟๆ ท็ใ
+
+ไฝ ็ๆๅกๅจๆญฃๅจ็ญๅพ
ๅพๅคๅพๅค็จๆท้่ฟไปไปฌไธๅคชๅฅฝ็็ฝ็ปๅ้ๆฅ็่ฏทๆฑใ
+
+็ถๅๅๆฌก็ญๅพ
๐ ๅๅบๅๆฅใ
+
+่ฟไธช"็ญๅพ
" ๐ ๆฏไปฅๅพฎ็งไธบๅไฝๆต้็๏ผไฝๆป็ๆฅ่ฏด๏ผๆๅ่ฟๆฏ็ญๅพ
ๅพไน
ใ
+
+่ฟๅฐฑๆฏไธบไปไนไฝฟ็จๅผๆญฅๅฏนไบ Web API ๅพๆๆไน็ๅๅ โธ๐โฏใ
+
+่ฟ็งๅผๆญฅๆบๅถๆญฃๆฏ NodeJS ๅๅฐๆฌข่ฟ็ๅๅ ๏ผๅฐฝ็ฎก NodeJS ไธๆฏๅนถ่ก็๏ผ๏ผไปฅๅ Go ไฝไธบ็ผ็จ่ฏญ่จ็ไผๅฟๆๅจใ
+
+่ฟไธ **FastAPI** ็ๆง่ฝๆฐดๅนณ็ธๅใ
+
+ๆจๅฏไปฅๅๆถๆฅๆๅนถ่กๆงๅๅผๆญฅๆง๏ผๆจๅฏไปฅ่ทๅพๆฏๅคงๅคๆฐ็ป่ฟๆต่ฏ็ NodeJS ๆกๆถๆด้ซ็ๆง่ฝ๏ผๅนถไธไธ Go ไธ็ธไธไธ๏ผ Go ๆฏไธ็งๆดๆฅ่ฟไบ C ็็ผ่ฏ่ฏญ่จ๏ผๅ
จ้จๅฝๅไบ Starlette๏ผใ
+
+### ๅนถๅๆฏๅนถ่กๅฅฝๅ๏ผ
+
+ไธ๏ผ่ฟไธๆฏๆ
ไบ็ๆฌๆใ
+
+ๅนถๅไธๅไบๅนถ่กใ่ๆฏๅจ้่ฆๅคง้็ญๅพ
็็นๅฎๅบๆฏไธๆๆๆดๅฅฝใๅ ๆญค๏ผๅจ Web ๅบ็จ็จๅบๅผๅไธญ๏ผๅฎ้ๅธธๆฏๅนถ่ก่ฆๅฅฝๅพๅค๏ผไฝ่ฟๅนถไธๆๅณ็ๅ
จ้จใ
+
+ๅ ๆญค๏ผไธบไบๅนณ่กก่ฟไธ็น๏ผๆณ่ฑกไธไธไธ้ข็็ญ็ฏๆ
ไบ๏ผ
+
+> ไฝ ๅฟ
้กปๆๆซไธไธชๅๅคงๅ่็ๆฟๅญใ
+
+*ๆฏ็๏ผ่ฟๅฐฑๆฏๅฎๆด็ๆ
ไบใ*
+
+---
+
+ๅจไปปไฝๅฐๆน๏ผ ้ฝไธ้่ฆ็ญๅพ
๐ ๏ผๅช้่ฆๅจๆฟๅญ็ๅคไธชๅฐๆนๅ็ๅพๅคๅทฅไฝใ
+
+ไฝ ๅฏไปฅๅๆฑๅ ก็ไพๅญ้ฃๆ ท่ฝฎๆตๆง่ก๏ผๅ
ๆฏๅฎขๅ
๏ผ็ถๅๆฏๅจๆฟ๏ผไฝๅ ไธบไฝ ไธ้่ฆ็ญๅพ
๐ ๏ผๅฏนไบไปปไฝไบๆ
้ฝๆฏๆธ
ๆด๏ผๆธ
ๆด๏ผ่ฟๆฏๆธ
ๆด๏ผ่ฝฎๆตไธไผๅฝฑๅไปปไฝไบๆ
ใ
+
+ๆ ่ฎบๆฏๅฆ่ฝฎๆตๆง่ก๏ผๅนถๅ๏ผ๏ผ้ฝ้่ฆ็ธๅ็ๆถ้ดๆฅๅฎๆ๏ผ่ไฝ ไนไผๅฎๆ็ธๅ็ๅทฅไฝ้ใ
+
+ไฝๅจ่ฟ็งๆ
ๅตไธ๏ผๅฆๆไฝ ่ฝๅธฆไธ 8 ๅๅๆถ้ถๅ/ๅจๅธ๏ผ็ฐๅจๆฏๆธ
ๆดๅทฅไธ่ตทๆธ
ๆซ๏ผไปไปฌไธญ็ๆฏไธไธชไบบ๏ผๅ ไธไฝ ๏ผ้ฝ่ฝๅ ๆฎๆฟๅญ็ไธไธชๅบๅๆฅๆธ
ๆซ๏ผไฝ ๅฐฑๅฏไปฅๅจ้ขๅค็ๅธฎๅฉไธๅนถ่ก็ๆดๅฟซๅฐๅฎๆๆๆๅทฅไฝใ
+
+ๅจ่ฟไธชๅบๆฏไธญ๏ผๆฏไธชๆธ
ๆดๅทฅ๏ผๅ
ๆฌๆจ๏ผ้ฝๅฐๆฏไธไธชๅค็ๅจ๏ผๅฎๆ่ฟไธชๅทฅไฝ็ไธ้จๅใ
+
+็ฑไบๅคงๅคๆฐๆง่กๆถ้ดๆฏ็ฑๅฎ้
ๅทฅไฝ๏ผ่ไธๆฏ็ญๅพ
๏ผๅ ็จ็๏ผๅนถไธ่ฎก็ฎๆบไธญ็ๅทฅไฝๆฏ็ฑ CPU ๅฎๆ็๏ผๆไปฅไปไปฌ็งฐ่ฟไบ้ฎ้ขไธบ"CPU ๅฏ้ๅ"ใ
+
+---
+
+CPU ๅฏ้ๅๆไฝ็ๅธธ่ง็คบไพๆฏ้่ฆๅคๆ็ๆฐๅญฆๅค็ใ
+
+ไพๅฆ๏ผ
+
+* **้ณ้ข**ๆ**ๅพๅ**ๅค็๏ผ
+* **่ฎก็ฎๆบ่ง่ง**: ไธๅน
ๅพๅ็ฑๆฐ็พไธๅ็ด ็ปๆ๏ผๆฏไธชๅ็ด ๆ3็ง้ข่ฒๅผ๏ผๅค็้ๅธธ้่ฆๅๆถๅฏน่ฟไบๅ็ด ่ฟ่ก่ฎก็ฎ๏ผ
+* **ๆบๅจๅญฆไน **: ๅฎ้ๅธธ้่ฆๅคง้็"็ฉ้ต"ๅ"ๅ้"ไนๆณใๆณ่ฑกไธไธชๅ
ๅซๆฐๅญ็ๅทจๅคง็ตๅญ่กจๆ ผ๏ผๅนถๅๆถๅฐๆๆๆฐๅญ็ธไน๏ผ
+* **ๆทฑๅบฆๅญฆไน **: ่ฟๆฏๆบๅจๅญฆไน ็ไธไธชๅญ้ขๅ๏ผๅๆ ท้็จใๅชๆฏๆฒกๆไธไธชๆฐๅญ็็ตๅญ่กจๆ ผๅฏไปฅ็ธไน๏ผ่ๆฏไธไธชๅบๅคง็ๆฐๅญ้ๅ๏ผๅจๅพๅคๆ
ๅตไธ๏ผไฝ ้่ฆไฝฟ็จไธไธช็นๆฎ็ๅค็ๅจๆฅๆๅปบๅไฝฟ็จ่ฟไบๆจกๅใ
+
+### ๅนถๅ + ๅนถ่ก: Web + ๆบๅจๅญฆไน
+
+ไฝฟ็จ **FastAPI**๏ผๆจๅฏไปฅๅฉ็จ Web ๅผๅไธญๅธธ่ง็ๅนถๅๆบๅถ็ไผๅฟ๏ผNodeJS ็ไธป่ฆๅธๅผๅ๏ผใ
+
+ๅนถไธ๏ผๆจไนๅฏไปฅๅฉ็จๅนถ่กๅๅค่ฟ็จ๏ผ่ฎฉๅคไธช่ฟ็จๅนถ่ก่ฟ่ก๏ผ็ไผ็นๆฅๅค็ไธๆบๅจๅญฆไน ็ณป็ปไธญ็ฑปไผผ็ **CPU ๅฏ้ๅ** ๅทฅไฝใ
+
+่ฟไธ็น๏ผๅๅ ไธ Python ๆฏ**ๆฐๆฎ็งๅญฆ**ใๆบๅจๅญฆไน ๏ผๅฐคๅ
ถๆฏๆทฑๅบฆๅญฆไน ๏ผ็ไธป่ฆ่ฏญ่จ่ฟไธ็ฎๅไบๅฎ๏ผไฝฟๅพ **FastAPI** ไธๆฐๆฎ็งๅญฆ/ๆบๅจๅญฆไน Web API ๅๅบ็จ็จๅบ๏ผไปฅๅๅ
ถไป่ฎธๅคๅบ็จ็จๅบ๏ผ้ๅธธๅน้
ใ
+
+ไบ่งฃๅฆไฝๅจ็ไบง็ฏๅขไธญๅฎ็ฐ่ฟ็งๅนถ่กๆง๏ผๅฏๆฅ็ๆญคๆ [Deployment](deployment/index.md){.internal-link target=_blank}ใ
+
+## `async` ๅ `await`
+
+็ฐไปฃ็ๆฌ็ Python ๆไธ็ง้ๅธธ็ด่ง็ๆนๅผๆฅๅฎไนๅผๆญฅไปฃ็ ใ่ฟไฝฟๅฎ็่ตทๆฅๅฐฑๅๆญฃๅธธ็"้กบๅบ"ไปฃ็ ๏ผๅนถๅจ้ๅฝ็ๆถๅ"็ญๅพ
"ใ
+
+ๅฝๆไธไธชๆไฝ้่ฆ็ญๅพ
ๆ่ฝ็ปๅบ็ปๆ๏ผไธๆฏๆ่ฟไธชๆฐ็ Python ็นๆงๆถ๏ผๆจๅฏไปฅ็ผๅๅฆไธไปฃ็ ๏ผ
+
+```Python
+burgers = await get_burgers(2)
+```
+
+่ฟ้็ๅ
ณ้ฎๆฏ `await`ใๅฎๅ่ฏ Python ๅฎๅฟ
้กป็ญๅพ
โธ `get_burgers(2)` ๅฎๆๅฎ็ๅทฅไฝ ๐ ๏ผ็ถๅๅฐ็ปๆๅญๅจๅจ `burgers` ไธญใ่ฟๆ ท๏ผPython ๅฐฑไผ็ฅ้ๆญคๆถๅฎๅฏไปฅๅปๅๅ
ถไปไบๆ
๐ โฏ ๏ผๆฏๅฆๆฅๆถๅฆไธไธช่ฏทๆฑ๏ผใ
+
+่ฆไฝฟ `await` ๅทฅไฝ๏ผๅฎๅฟ
้กปไฝไบๆฏๆ่ฟ็งๅผๆญฅๆบๅถ็ๅฝๆฐๅ
ใๅ ๆญค๏ผๅช้ไฝฟ็จ `async def` ๅฃฐๆๅฎ๏ผ
+
+```Python hl_lines="1"
+async def get_burgers(number: int):
+ # Do some asynchronous stuff to create the burgers
+ return burgers
+```
+
+...่ไธๆฏ `def`:
+
+```Python hl_lines="2"
+# This is not asynchronous
+def get_sequential_burgers(number: int):
+ # Do some sequential stuff to create the burgers
+ return burgers
+```
+
+ไฝฟ็จ `async def`๏ผPython ๅฐฑ็ฅ้ๅจ่ฏฅๅฝๆฐไธญ๏ผๅฎๅฐ้ไธ `await`๏ผๅนถไธๅฎๅฏไปฅ"ๆๅ" โธ ๆง่ก่ฏฅๅฝๆฐ๏ผ็ด่ณๆง่กๅ
ถไปๆไฝ ๐ ๅๅๆฅใ
+
+ๅฝไฝ ๆณ่ฐ็จไธไธช `async def` ๅฝๆฐๆถ๏ผไฝ ๅฟ
้กป"็ญๅพ
"ๅฎใๅ ๆญค๏ผ่ฟไธไผ่ตทไฝ็จ๏ผ
+
+```Python
+# This won't work, because get_burgers was defined with: async def
+burgers = get_burgers(2)
+```
+
+---
+
+ๅ ๆญค๏ผๅฆๆๆจไฝฟ็จ็ๅบๅ่ฏๆจๅฏไปฅไฝฟ็จ `await` ่ฐ็จๅฎ๏ผๅ้่ฆไฝฟ็จ `async def` ๅๅปบ่ทฏๅพๆไฝๅฝๆฐ ๏ผๅฆ๏ผ
+
+```Python hl_lines="2-3"
+@app.get('/burgers')
+async def read_burgers():
+ burgers = await get_burgers(2)
+ return burgers
+```
+
+### ๆดๅคๆๆฏ็ป่
+
+ๆจๅฏ่ฝๅทฒ็ปๆณจๆๅฐ๏ผ`await` ๅช่ฝๅจ `async def` ๅฎไน็ๅฝๆฐๅ
้จไฝฟ็จใ
+
+ไฝไธๆญคๅๆถ๏ผๅฟ
้กป"็ญๅพ
"้่ฟ `async def` ๅฎไน็ๅฝๆฐใๅ ๆญค๏ผๅธฆ `async def` ็ๅฝๆฐไนๅช่ฝๅจ `async def` ๅฎไน็ๅฝๆฐๅ
้จ่ฐ็จใ
+
+้ฃไน๏ผ่ฟๅ
ณไบๅ
ๆ้ธก่ฟๆฏๅ
ๆ่็้ฎ้ข๏ผๅฆไฝ่ฐ็จ็ฌฌไธไธช `async` ๅฝๆฐ๏ผ
+
+ๅฆๆๆจไฝฟ็จ **FastAPI**๏ผไฝ ไธๅฟ
ๆ
ๅฟ่ฟไธ็น๏ผๅ ไธบ"็ฌฌไธไธช"ๅฝๆฐๅฐๆฏไฝ ็่ทฏๅพๆไฝๅฝๆฐ๏ผFastAPI ๅฐ็ฅ้ๅฆไฝๅๆญฃ็กฎ็ไบๆ
ใ
+
+ไฝๅฆๆๆจๆณๅจๆฒกๆ FastAPI ็ๆ
ๅตไธไฝฟ็จ `async` / `await`๏ผๅๅฏไปฅ่ฟๆ ทๅใ
+
+### ็ผๅ่ชๅทฑ็ๅผๆญฅไปฃ็
+
+Starlette ๏ผๅ **FastAPI**๏ผ ๆฏๅบไบ AnyIO ๅฎ็ฐ็๏ผ่ฟไฝฟๅพๅฎไปฌๅฏไปฅๅ
ผๅฎน Python ็ๆ ๅๅบ asyncio ๅ Trioใ
+
+็นๅซๆฏ๏ผไฝ ๅฏไปฅ็ดๆฅไฝฟ็จ AnyIO ๆฅๅค็้ซ็บง็ๅนถๅ็จไพ๏ผ่ฟไบ็จไพ้่ฆๅจ่ชๅทฑ็ไปฃ็ ไธญไฝฟ็จๆด้ซ็บง็ๆจกๅผใ
+
+ๅณไฝฟๆจๆฒกๆไฝฟ็จ **FastAPI**๏ผๆจไนๅฏไปฅไฝฟ็จ AnyIO ็ผๅ่ชๅทฑ็ๅผๆญฅ็จๅบ๏ผไฝฟๅ
ถๆฅๆ่พ้ซ็ๅ
ผๅฎนๆงๅนถ่ทๅพไธไบๅฅฝๅค๏ผไพๅฆ๏ผ ็ปๆๅๅนถๅ๏ผใ
+
+### ๅ
ถไปๅฝขๅผ็ๅผๆญฅไปฃ็
+
+่ฟ็งไฝฟ็จ `async` ๅ `await` ็้ฃๆ ผๅจ่ฏญ่จไธญ็ธๅฏน่พๆฐใ
+
+ไฝๅฎไฝฟๅค็ๅผๆญฅไปฃ็ ๅๅพๅฎนๆๅพๅคใ
+
+่ฟ็ง็ธๅ็่ฏญๆณ๏ผๆๅ ไน็ธๅ๏ผๆ่ฟไนๅ
ๅซๅจ็ฐไปฃ็ๆฌ็ JavaScript ไธญ๏ผๅจๆต่งๅจๅ NodeJS ไธญ๏ผใ
+
+ไฝๅจๆญคไนๅ๏ผๅค็ๅผๆญฅไปฃ็ ้ๅธธๅคๆๅๅฐ้พใ
+
+ๅจไปฅๅ็ๆฌ็ Python๏ผไฝ ๅฏไปฅไฝฟ็จๅค็บฟ็จๆ่
Geventใไฝไปฃ็ ็็่งฃใ่ฐ่ฏๅๆ่้ฝ่ฆๅคๆ่ฎธๅคใ
+
+ๅจไปฅๅ็ๆฌ็ NodeJS / ๆต่งๅจ JavaScript ไธญ๏ผไฝ ไผไฝฟ็จ"ๅ่ฐ"๏ผๅ ๆญคไนๅฏ่ฝๅฏผ่ดๅ่ฐๅฐ็ฑใ
+
+## ๅ็จ
+
+**ๅ็จ**ๅชๆฏ `async def` ๅฝๆฐ่ฟๅ็ไธไธช้ๅธธๅฅ็น็ไธ่ฅฟ็็งฐๅผใPython ็ฅ้ๅฎๆ็นๅไธไธชๅฝๆฐ๏ผๅฎๅฏไปฅๅฏๅจ๏ผไนไผๅจๆไธชๆถๅป็ปๆ๏ผ่ไธๅฎๅฏ่ฝไผๅจๅ
้จๆๅ โธ ๏ผๅช่ฆๅ
้จๆไธไธช `await`ใ
+
+้่ฟไฝฟ็จ `async` ๅ `await` ็ๅผๆญฅไปฃ็ ็ๆๆๅ่ฝๅคงๅคๆฐ่ขซๆฆๆฌไธบ"ๅ็จ"ใๅฎๅฏไปฅไธ Go ็ไธป่ฆๅ
ณ้ฎ็นๆง "Goroutines" ็ธๅชฒ็พใ
+
+## ็ป่ฎบ
+
+่ฎฉๆไปฌๅๆฅๅ้กพไธไธๆๆ่ฏด็๏ผ
+
+> Python ็็ฐไปฃ็ๆฌๅฏไปฅ้่ฟไฝฟ็จ `async` ๅ `await` ่ฏญๆณๅๅปบ**ๅ็จ**๏ผๅนถ็จไบๆฏๆ**ๅผๆญฅไปฃ็ **ใ
+
+็ฐๅจๅบ่ฏฅ่ฝๆ็ฝๅ
ถๅซไนไบใโจ
+
+ๆๆ่ฟไบไฝฟๅพ FastAPI๏ผ้่ฟ Starlette๏ผๅฆๆญคๅผบๅคง๏ผไนๆฏๅฎๆฅๆๅฆๆญคไปคไบบๅฐ่ฑกๆทฑๅป็ๆง่ฝ็ๅๅ ใ
+
+## ้ๅธธๆๆฏๆง็็ป่
+
+!!! warning
+ ไฝ ๅฏไปฅ่ทณ่ฟ่ฟ้ใ
+
+ ่ฟไบ้ฝๆฏ FastAPI ๅฆไฝๅจๅ
้จๅทฅไฝ็ๆๆฏ็ป่ใ
+
+ ๅฆๆๆจๆ็ธๅฝๅค็ๆๆฏ็ฅ่ฏ๏ผๅ็จใ็บฟ็จใ้ปๅก็ญ๏ผ๏ผๅนถไธๅฏน FastAPI ๅฆไฝๅค็ `async def` ไธๅธธ่ง `def` ๆๅฐๅฅฝๅฅ๏ผ่ฏท็ปง็ปญใ
+
+### ่ทฏๅพๆไฝๅฝๆฐ
+
+ๅฝไฝ ไฝฟ็จ `def` ่ไธๆฏ `async def` ๆฅๅฃฐๆไธไธช*่ทฏๅพๆไฝๅฝๆฐ*ๆถ๏ผๅฎ่ฟ่กๅจๅค้จ็็บฟ็จๆฑ ไธญๅนถ็ญๅพ
ๅ
ถ็ปๆ๏ผ่ไธๆฏ็ดๆฅ่ฐ็จ๏ผๅ ไธบๅฎไผ้ปๅกๆๅกๅจ๏ผใ
+
+ๅฆๆๆจไฝฟ็จ่ฟๅฆไธไธชไธไปฅไธ่ฟฐๆนๅผๅทฅไฝ็ๅผๆญฅๆกๆถ๏ผๅนถไธๆจไน ๆฏไบ็จๆฎ้็ `def` ๅฎไนๆฎ้็ไป
่ฎก็ฎ่ทฏๅพๆไฝๅฝๆฐ๏ผไปฅ่ทๅพๅพฎๅฐ็ๆง่ฝๅข็๏ผๅคง็บฆ100็บณ็ง๏ผ๏ผ่ฏทๆณจๆ๏ผๅจ FastAPI ไธญ๏ผๆๆๅฐๅฎๅ
จ็ธๅใๅจ่ฟไบๆ
ๅตไธ๏ผๆๅฅฝไฝฟ็จ `async def`๏ผ้ค้่ทฏๅพๆไฝๅฝๆฐๅ
ไฝฟ็จๆง่ก้ปๅก I/O ็ไปฃ็ ใ
+
+ๅจ่ฟไธค็งๆ
ๅตไธ๏ผไธๆจไนๅ็ๆกๆถ็ธๆฏ๏ผ**FastAPI** ๅฏ่ฝ[ไป็ถๅพๅฟซ](/#performance){.internal-link target=_blank}ใ
+
+### ไพ่ต
+
+่ฟๅๆ ท้็จไบ[ไพ่ต](/tutorial/dependencies/index.md){.internal-link target=_blank}ใๅฆๆไธไธชไพ่ตๆฏๆ ๅ็ `def` ๅฝๆฐ่ไธๆฏ `async def`๏ผๅฎๅฐ่ขซ่ฟ่กๅจๅค้จ็บฟ็จๆฑ ไธญใ
+
+### ๅญไพ่ต
+
+ไฝ ๅฏไปฅๆฅๆๅคไธช็ธไบไพ่ต็ไพ่ตไปฅๅ[ๅญไพ่ต](/tutorial/dependencies/sub-dependencies.md){.internal-link target=_blank} ๏ผไฝไธบๅฝๆฐ็ๅๆฐ๏ผ๏ผๅฎไปฌไธญ็ไธไบๅฏ่ฝๆฏ้่ฟ `async def` ๅฃฐๆ๏ผไนๅฏ่ฝๆฏ้่ฟ `def` ๅฃฐๆใๅฎไปฌไป็ถๅฏไปฅๆญฃๅธธๅทฅไฝ๏ผ่ฟไบ้่ฟ `def` ๅฃฐๆ็ๅฝๆฐๅฐไผๅจๅค้จ็บฟ็จไธญ่ฐ็จ๏ผๆฅ่ช็บฟ็จๆฑ ๏ผ๏ผ่ไธๆฏ"่ขซ็ญๅพ
"ใ
+
+### ๅ
ถไปๅฝๆฐ
+
+ๆจๅฏ็ดๆฅ่ฐ็จ้่ฟ `def` ๆ `async def` ๅๅปบ็ไปปไฝๅ
ถไปๅฝๆฐ๏ผFastAPI ไธไผๅฝฑๅๆจ่ฐ็จๅฎไปฌ็ๆนๅผใ
+
+่ฟไธ FastAPI ไธบๆจ่ฐ็จ*่ทฏๅพๆไฝๅฝๆฐ*ๅไพ่ต้กน็้ป่พ็ธๅใ
+
+ๅฆๆไฝ ็ๅฝๆฐๆฏ้่ฟ `def` ๅฃฐๆ็๏ผๅฎๅฐ่ขซ็ดๆฅ่ฐ็จ๏ผๅจไปฃ็ ไธญ็ผๅ็ๅฐๆน๏ผ๏ผ่ไธไผๅจ็บฟ็จๆฑ ไธญ๏ผๅฆๆ่ฟไธชๅฝๆฐ้่ฟ `async def` ๅฃฐๆ๏ผๅฝๅจไปฃ็ ไธญ่ฐ็จๆถ๏ผไฝ ๅฐฑๅบ่ฏฅไฝฟ็จ `await` ็ญๅพ
ๅฝๆฐ็็ปๆใ
+
+---
+
+ๅๆฌกๆ้๏ผ่ฟไบๆฏ้ๅธธๆๆฏๆง็็ป่๏ผๅฆๆไฝ ๆฅๆ็ดขๅฎๅฏ่ฝๅฏนไฝ ๆ็จใ
+
+ๅฆๅ๏ผๆจๆๅฅฝๅบ่ฏฅ้ตๅฎ็ๆๅฏผๅๅ่ตถๆถ้ดๅ๏ผ.
diff --git a/docs/zh/docs/deployment/versions.md b/docs/zh/docs/deployment/versions.md
new file mode 100644
index 000000000..75b870139
--- /dev/null
+++ b/docs/zh/docs/deployment/versions.md
@@ -0,0 +1,87 @@
+# ๅ
ณไบ FastAPI ็ๆฌ
+
+**FastAPI** ๅทฒๅจ่ฎธๅคๅบ็จ็จๅบๅ็ณป็ป็็ไบง็ฏๅขไธญไฝฟ็จใ ๅนถไธๆต่ฏ่ฆ็็ไฟๆๅจ100%ใ ไฝๅ
ถๅผๅ่ฟๅบฆไปๅจๅฟซ้ๆจ่ฟใ
+
+็ปๅธธๆทปๅ ๆฐๅ่ฝ๏ผๅฎๆไฟฎๅค้่ฏฏ๏ผๅนถไธไปฃ็ ไปๅจๆ็ปญๆน่ฟใ
+
+่ฟๅฐฑๆฏไธบไปไนๅฝๅ็ๆฌไป็ถๆฏ`0.x.x`๏ผ่ฟๅๆ ๅบๆฏไธช็ๆฌ้ฝๅฏ่ฝๆBreaking changesใ ่ฟ้ตๅพช่ฏญไน็ๆฌๆงๅถ็็บฆๅฎใ
+
+ไฝ ็ฐๅจๅฐฑๅฏไปฅไฝฟ็จ **FastAPI** ๅๅปบ็ไบง็ฏๅขๅบ็จ็จๅบ๏ผไฝ ๅฏ่ฝๅทฒ็ป่ฟๆ ทๅไบไธๆฎตๆถ้ด๏ผ๏ผไฝ ๅช้็กฎไฟไฝฟ็จ็็ๆฌๅฏไปฅไธๅ
ถไฝไปฃ็ ๆญฃ็กฎ้
ๅๅณๅฏใ
+
+## ๅบๅฎไฝ ็ `fastapi` ็ๆฌ
+
+ไฝ ๅบ่ฏฅๅ็็ฌฌไธไปถไบๆฏๅฐไฝ ๆญฃๅจไฝฟ็จ็ **FastAPI** ็ๆฌโๅบๅฎโๅฐไฝ ็ฅ้้็จไบไฝ ็ๅบ็จ็จๅบ็็นๅฎๆๆฐ็ๆฌใ
+
+ไพๅฆ๏ผๅ่ฎพไฝ ๅจๅบ็จ็จๅบไธญไฝฟ็จ็ๆฌ`0.45.0`ใ
+
+ๅฆๆไฝ ไฝฟ็จ`requirements.txt`ๆไปถ๏ผไฝ ๅฏไปฅไฝฟ็จไปฅไธๅฝไปคๆๅฎ็ๆฌ๏ผ
+
+````txt
+fastapi==0.45.0
+````
+
+่ฟๆๅณ็ไฝ ๅฐไฝฟ็จ็ๆฌ`0.45.0`ใ
+
+ๆ่
ไฝ ไนๅฏไปฅๅฐๅ
ถๅบๅฎไธบ๏ผ
+
+````txt
+fastapi>=0.45.0,<0.46.0
+````
+
+่ฟๆๅณ็ไฝ ๅฐไฝฟ็จ`0.45.0`ๆๆด้ซ็ๆฌ๏ผไฝไฝไบ`0.46.0`๏ผไพๅฆ๏ผ็ๆฌ`0.45.2`ไปไผ่ขซๆฅๅใ
+
+ๅฆๆไฝ ไฝฟ็จไปปไฝๅ
ถไปๅทฅๅ
ทๆฅ็ฎก็ไฝ ็ๅฎ่ฃ
๏ผไพๅฆ PoetryใPipenv ๆๅ
ถไปๅทฅๅ
ท๏ผๅฎไปฌ้ฝๆไธ็งๅฎไนๅ
็็นๅฎ็ๆฌ็ๆนๆณใ
+
+## ๅฏ็จ็ๆฌ
+
+ไฝ ๅฏไปฅๅจ[ๅ่ก่ฏดๆ](../release-notes.md){.internal-link target=_blank}ไธญๆฅ็ๅฏ็จ็ๆฌ๏ผไพๅฆๆฅ็ๅฝๅๆๆฐ็ๆฌ๏ผใ
+
+## ๅ
ณไบ็ๆฌ
+
+้ตๅพช่ฏญไน็ๆฌๆงๅถ็บฆๅฎ๏ผไปปไฝไฝไบ`1.0.0`็็ๆฌ้ฝๅฏ่ฝไผๆทปๅ breaking changesใ
+
+FastAPI ่ฟ้ตๅพช่ฟๆ ท็็บฆๅฎ๏ผไปปไฝ`PATCH`็ๆฌๆดๆน้ฝๆฏไธบไบbugไฟฎๅคๅnon-breaking changesใ
+
+!!! tip
+ "PATCH"ๆฏๆๅไธไธชๆฐๅญ๏ผไพๅฆ๏ผๅจ`0.2.3`ไธญ๏ผPATCH็ๆฌๆฏ`3`ใ
+
+ๅ ๆญค๏ผไฝ ๅบ่ฏฅ่ฝๅคๅบๅฎๅฐๅฆไธ็ๆฌ๏ผ
+
+```txt
+fastapi>=0.45.0,<0.46.0
+```
+
+"MINOR"็ๆฌไธญไผๆทปๅ breaking changesๅๆฐๅ่ฝใ
+
+!!! tip
+ "MINOR"ๆฏไธญ้ด็ๆฐๅญ๏ผไพๅฆ๏ผๅจ`0.2.3`ไธญ๏ผMINOR็ๆฌๆฏ`2`ใ
+
+## ๅ็บงFastAPI็ๆฌ
+
+ไฝ ๅบ่ฏฅไธบไฝ ็ๅบ็จ็จๅบๆทปๅ ๆต่ฏใ
+
+ไฝฟ็จ **FastAPI** ็ผๅๆต่ฏ้ๅธธ็ฎๅ๏ผๆ่ฐข Starlette๏ผ๏ผ่ฏทๅ่ๆๆกฃ๏ผ[ๆต่ฏ](../tutorial/testing.md){.internal-link target=_blank}
+
+ๆทปๅ ๆต่ฏๅ๏ผไฝ ๅฏไปฅๅฐ **FastAPI** ็ๆฌๅ็บงๅฐๆดๆฐ็ๆฌ๏ผๅนถ้่ฟ่ฟ่กๆต่ฏๆฅ็กฎไฟๆๆไปฃ็ ้ฝ่ฝๆญฃๅธธๅทฅไฝใ
+
+ๅฆๆไธๅๆญฃๅธธ๏ผๆ่
ๅจ่ฟ่กๅฟ
่ฆ็ๆดๆนไนๅ๏ผๅนถไธๆๆๆต่ฏ้ฝ้่ฟไบ๏ผ้ฃไนไฝ ๅฏไปฅๅฐ`fastapi`ๅบๅฎๅฐๆฐ็็ๆฌใ
+
+## ๅ
ณไบStarlette
+
+ไฝ ไธๅบ่ฏฅๅบๅฎ`starlette`็็ๆฌใ
+
+ไธๅ็ๆฌ็ **FastAPI** ๅฐไฝฟ็จ็นๅฎ็่พๆฐ็ๆฌ็ Starletteใ
+
+ๅ ๆญค๏ผ**FastAPI** ่ชๅทฑๅฏไปฅไฝฟ็จๆญฃ็กฎ็ Starlette ็ๆฌใ
+
+## ๅ
ณไบ Pydantic
+
+Pydantic ๅ
ๅซ้ๅฏน **FastAPI** ็ๆต่ฏๅๅ
ถ่ชๅทฑ็ๆต่ฏ๏ผๅ ๆญค Pydantic ็ๆฐ็ๆฌ๏ผ`1.0.0`ไปฅไธ๏ผๅง็ปไธ FastAPI ๅ
ผๅฎนใ
+
+ไฝ ๅฏไปฅๅฐ Pydantic ๅบๅฎๅฐ้ๅไฝ ็`1.0.0`ไปฅไธๅ`2.0.0`ไปฅไธ็ไปปไฝ็ๆฌใ
+
+ไพๅฆ๏ผ
+
+````txt
+pydantic>=1.2.0,<2.0.0
+````
diff --git a/docs/zh/docs/help-fastapi.md b/docs/zh/docs/help-fastapi.md
index 2a99950e3..9b70d115a 100644
--- a/docs/zh/docs/help-fastapi.md
+++ b/docs/zh/docs/help-fastapi.md
@@ -114,8 +114,6 @@
่ๅคฉๅฎคไป
ไพ้ฒ่ใ
-ๆไปฌไนๅ่ฟไฝฟ็จ่ฟ Gitter chat๏ผไฝๅฎไธๆฏๆ้ข้็ญ้ซ็บงๅ่ฝ๏ผ่ๅคฉไนๆฏ่พ้บป็ฆ๏ผๆไปฅ็ฐๅจๆจ่ไฝฟ็จ Discordใ
-
### ๅซๅจ่ๅคฉๅฎค้ๆ้ฎ
ๆณจๆ๏ผ่ๅคฉๅฎคๆดๅพๅไบโ้ฒ่โ๏ผ็ปๅธธๆไบบไผๆๅบไธไบ็ฌผ็ปๅพ่ฎฉไบบ้พไปฅๅ็ญ็้ฎ้ข๏ผๆไปฅๅจ่ฟ้ๆ้ฎไธ่ฌๆฒกไบบๅ็ญใ
diff --git a/docs/zh/docs/index.md b/docs/zh/docs/index.md
index 1de2a8d36..d776e5813 100644
--- a/docs/zh/docs/index.md
+++ b/docs/zh/docs/index.md
@@ -24,7 +24,7 @@
---
-FastAPI ๆฏไธไธช็จไบๆๅปบ API ็็ฐไปฃใๅฟซ้๏ผ้ซๆง่ฝ๏ผ็ web ๆกๆถ๏ผไฝฟ็จ Python 3.6+ ๅนถๅบไบๆ ๅ็ Python ็ฑปๅๆ็คบใ
+FastAPI ๆฏไธไธช็จไบๆๅปบ API ็็ฐไปฃใๅฟซ้๏ผ้ซๆง่ฝ๏ผ็ web ๆกๆถ๏ผไฝฟ็จ Python 3.8+ ๅนถๅบไบๆ ๅ็ Python ็ฑปๅๆ็คบใ
ๅ
ณ้ฎ็นๆง:
@@ -107,7 +107,7 @@ FastAPI ๆฏไธไธช็จไบๆๅปบ API ็็ฐไปฃใๅฟซ้๏ผ้ซๆง่ฝ๏ผ็ web ๆก
## ไพ่ต
-Python 3.6 ๅๆด้ซ็ๆฌ
+Python 3.8 ๅๆด้ซ็ๆฌ
FastAPI ็ซๅจไปฅไธๅทจไบบ็่ฉ่ไนไธ๏ผ
@@ -323,7 +323,7 @@ def update_item(item_id: int, item: Item):
ไฝ ไธ้่ฆๅปๅญฆไน ๆฐ็่ฏญๆณใไบ่งฃ็นๅฎๅบ็ๆนๆณๆ็ฑป๏ผ็ญ็ญใ
-ๅช้่ฆไฝฟ็จๆ ๅ็ **Python 3.6 ๅๆด้ซ็ๆฌ**ใ
+ๅช้่ฆไฝฟ็จๆ ๅ็ **Python 3.8 ๅๆด้ซ็ๆฌ**ใ
ไธพไธชไพๅญ๏ผๆฏๅฆๅฃฐๆ `int` ็ฑปๅ๏ผ
diff --git a/docs/zh/docs/tutorial/background-tasks.md b/docs/zh/docs/tutorial/background-tasks.md
index c8568298b..94b75d4fd 100644
--- a/docs/zh/docs/tutorial/background-tasks.md
+++ b/docs/zh/docs/tutorial/background-tasks.md
@@ -69,7 +69,7 @@
{!> ../../../docs_src/background_tasks/tutorial002_an_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="14 16 23 26"
{!> ../../../docs_src/background_tasks/tutorial002_an.py!}
@@ -84,7 +84,7 @@
{!> ../../../docs_src/background_tasks/tutorial002_py310.py!}
```
-=== "Python 3.6+ ๆฒกAnnotated"
+=== "Python 3.8+ ๆฒกAnnotated"
!!! tip
ๅฐฝๅฏ่ฝ้ๆฉไฝฟ็จ `Annotated` ็็ๆฌใ
diff --git a/docs/zh/docs/tutorial/body-fields.md b/docs/zh/docs/tutorial/body-fields.md
index c153784dc..fb6c6d9b6 100644
--- a/docs/zh/docs/tutorial/body-fields.md
+++ b/docs/zh/docs/tutorial/body-fields.md
@@ -18,7 +18,7 @@
{!> ../../../docs_src/body_fields/tutorial001_an_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="4"
{!> ../../../docs_src/body_fields/tutorial001_an.py!}
@@ -33,7 +33,7 @@
{!> ../../../docs_src/body_fields/tutorial001_py310.py!}
```
-=== "Python 3.6+ non-Annotated"
+=== "Python 3.8+ non-Annotated"
!!! tip
ๅฐฝๅฏ่ฝ้ๆฉไฝฟ็จ `Annotated` ็็ๆฌใ
@@ -61,7 +61,7 @@
{!> ../../../docs_src/body_fields/tutorial001_an_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="12-15"
{!> ../../../docs_src/body_fields/tutorial001_an.py!}
@@ -76,7 +76,7 @@
{!> ../../../docs_src/body_fields/tutorial001_py310.py!}
```
-=== "Python 3.6+ non-Annotated"
+=== "Python 3.8+ non-Annotated"
!!! tip
Prefer to use the `Annotated` version if possible.
diff --git a/docs/zh/docs/tutorial/body-multiple-params.md b/docs/zh/docs/tutorial/body-multiple-params.md
index ee2cba6df..c93ef2f5c 100644
--- a/docs/zh/docs/tutorial/body-multiple-params.md
+++ b/docs/zh/docs/tutorial/body-multiple-params.md
@@ -20,7 +20,7 @@
{!> ../../../docs_src/body_multiple_params/tutorial001_an_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="19-21"
{!> ../../../docs_src/body_multiple_params/tutorial001_an.py!}
@@ -35,7 +35,7 @@
{!> ../../../docs_src/body_multiple_params/tutorial001_py310.py!}
```
-=== "Python 3.6+ non-Annotated"
+=== "Python 3.8+ non-Annotated"
!!! tip
ๅฐฝๅฏ่ฝ้ๆฉไฝฟ็จ `Annotated` ็็ๆฌใ
@@ -68,7 +68,7 @@
{!> ../../../docs_src/body_multiple_params/tutorial002_py310.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="22"
{!> ../../../docs_src/body_multiple_params/tutorial002.py!}
@@ -124,7 +124,7 @@
{!> ../../../docs_src/body_multiple_params/tutorial003_an_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="24"
{!> ../../../docs_src/body_multiple_params/tutorial003_an.py!}
@@ -139,7 +139,7 @@
{!> ../../../docs_src/body_multiple_params/tutorial003_py310.py!}
```
-=== "Python 3.6+ non-Annotated"
+=== "Python 3.8+ non-Annotated"
!!! tip
ๅฐฝๅฏ่ฝ้ๆฉไฝฟ็จ `Annotated` ็็ๆฌใ
@@ -193,7 +193,7 @@ q: str = None
{!> ../../../docs_src/body_multiple_params/tutorial004_an_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="28"
{!> ../../../docs_src/body_multiple_params/tutorial004_an.py!}
@@ -208,7 +208,7 @@ q: str = None
{!> ../../../docs_src/body_multiple_params/tutorial004_py310.py!}
```
-=== "Python 3.6+ non-Annotated"
+=== "Python 3.8+ non-Annotated"
!!! tip
ๅฐฝๅฏ่ฝ้ๆฉไฝฟ็จ `Annotated` ็็ๆฌใ
@@ -247,7 +247,7 @@ item: Item = Body(embed=True)
{!> ../../../docs_src/body_multiple_params/tutorial005_an_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="18"
{!> ../../../docs_src/body_multiple_params/tutorial005_an.py!}
@@ -262,7 +262,7 @@ item: Item = Body(embed=True)
{!> ../../../docs_src/body_multiple_params/tutorial005_py310.py!}
```
-=== "Python 3.6+ non-Annotated"
+=== "Python 3.8+ non-Annotated"
!!! tip
ๅฐฝๅฏ่ฝ้ๆฉไฝฟ็จ `Annotated` ็็ๆฌใ
diff --git a/docs/zh/docs/tutorial/body-nested-models.md b/docs/zh/docs/tutorial/body-nested-models.md
index 7704d2624..c65308bef 100644
--- a/docs/zh/docs/tutorial/body-nested-models.md
+++ b/docs/zh/docs/tutorial/body-nested-models.md
@@ -12,7 +12,7 @@
{!> ../../../docs_src/body_nested_models/tutorial001_py310.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="14"
{!> ../../../docs_src/body_nested_models/tutorial001.py!}
@@ -63,7 +63,7 @@ my_list: List[str]
{!> ../../../docs_src/body_nested_models/tutorial002_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="14"
{!> ../../../docs_src/body_nested_models/tutorial002.py!}
@@ -89,7 +89,7 @@ Python ๅ
ทๆไธ็ง็นๆฎ็ๆฐๆฎ็ฑปๅๆฅไฟๅญไธ็ปๅฏไธ็ๅ
็ด ๏ผๅณ `se
{!> ../../../docs_src/body_nested_models/tutorial003_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="1 14"
{!> ../../../docs_src/body_nested_models/tutorial003.py!}
@@ -127,7 +127,7 @@ Pydantic ๆจกๅ็ๆฏไธชๅฑๆง้ฝๅ
ทๆ็ฑปๅใ
{!> ../../../docs_src/body_nested_models/tutorial004_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="9-11"
{!> ../../../docs_src/body_nested_models/tutorial004.py!}
@@ -149,7 +149,7 @@ Pydantic ๆจกๅ็ๆฏไธชๅฑๆง้ฝๅ
ทๆ็ฑปๅใ
{!> ../../../docs_src/body_nested_models/tutorial004_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="20"
{!> ../../../docs_src/body_nested_models/tutorial004.py!}
@@ -198,7 +198,7 @@ Pydantic ๆจกๅ็ๆฏไธชๅฑๆง้ฝๅ
ทๆ็ฑปๅใ
{!> ../../../docs_src/body_nested_models/tutorial005_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="4 10"
{!> ../../../docs_src/body_nested_models/tutorial005.py!}
@@ -222,7 +222,7 @@ Pydantic ๆจกๅ็ๆฏไธชๅฑๆง้ฝๅ
ทๆ็ฑปๅใ
{!> ../../../docs_src/body_nested_models/tutorial006_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="20"
{!> ../../../docs_src/body_nested_models/tutorial006.py!}
@@ -273,7 +273,7 @@ Pydantic ๆจกๅ็ๆฏไธชๅฑๆง้ฝๅ
ทๆ็ฑปๅใ
{!> ../../../docs_src/body_nested_models/tutorial007_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="9 14 20 23 27"
{!> ../../../docs_src/body_nested_models/tutorial007.py!}
@@ -298,7 +298,7 @@ images: List[Image]
{!> ../../../docs_src/body_nested_models/tutorial008_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="15"
{!> ../../../docs_src/body_nested_models/tutorial008.py!}
@@ -338,7 +338,7 @@ images: List[Image]
{!> ../../../docs_src/body_nested_models/tutorial009_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="9"
{!> ../../../docs_src/body_nested_models/tutorial009.py!}
diff --git a/docs/zh/docs/tutorial/body.md b/docs/zh/docs/tutorial/body.md
index d00c96dc3..5cf53c0c2 100644
--- a/docs/zh/docs/tutorial/body.md
+++ b/docs/zh/docs/tutorial/body.md
@@ -23,7 +23,7 @@
{!> ../../../docs_src/body/tutorial001_py310.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="4"
{!> ../../../docs_src/body/tutorial001.py!}
@@ -41,7 +41,7 @@
{!> ../../../docs_src/body/tutorial001_py310.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="7-11"
{!> ../../../docs_src/body/tutorial001.py!}
@@ -79,7 +79,7 @@
{!> ../../../docs_src/body/tutorial001_py310.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="18"
{!> ../../../docs_src/body/tutorial001.py!}
@@ -142,7 +142,7 @@ Pydantic ๆฌ่บซ็่ณไน่ฟ่กไบไธไบๆดๆนไปฅๆฏๆๆญคๅ่ฝใ
{!> ../../../docs_src/body/tutorial002_py310.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="21"
{!> ../../../docs_src/body/tutorial002.py!}
@@ -160,7 +160,7 @@ Pydantic ๆฌ่บซ็่ณไน่ฟ่กไบไธไบๆดๆนไปฅๆฏๆๆญคๅ่ฝใ
{!> ../../../docs_src/body/tutorial003_py310.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="17-18"
{!> ../../../docs_src/body/tutorial003.py!}
@@ -178,7 +178,7 @@ Pydantic ๆฌ่บซ็่ณไน่ฟ่กไบไธไบๆดๆนไปฅๆฏๆๆญคๅ่ฝใ
{!> ../../../docs_src/body/tutorial004_py310.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="18"
{!> ../../../docs_src/body/tutorial004.py!}
diff --git a/docs/zh/docs/tutorial/cookie-params.md b/docs/zh/docs/tutorial/cookie-params.md
index 470fd8e82..f115f9677 100644
--- a/docs/zh/docs/tutorial/cookie-params.md
+++ b/docs/zh/docs/tutorial/cookie-params.md
@@ -18,7 +18,7 @@
{!> ../../../docs_src/cookie_params/tutorial001_an_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="3"
{!> ../../../docs_src/cookie_params/tutorial001_an.py!}
@@ -33,7 +33,7 @@
{!> ../../../docs_src/cookie_params/tutorial001_py310.py!}
```
-=== "Python 3.6+ non-Annotated"
+=== "Python 3.8+ non-Annotated"
!!! tip
ๅฐฝๅฏ่ฝ้ๆฉไฝฟ็จ `Annotated` ็็ๆฌใ
@@ -61,7 +61,7 @@
{!> ../../../docs_src/cookie_params/tutorial001_an_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="10"
{!> ../../../docs_src/cookie_params/tutorial001_an.py!}
@@ -76,7 +76,7 @@
{!> ../../../docs_src/cookie_params/tutorial001_py310.py!}
```
-=== "Python 3.6+ non-Annotated"
+=== "Python 3.8+ non-Annotated"
!!! tip
ๅฐฝๅฏ่ฝ้ๆฉไฝฟ็จ `Annotated` ็็ๆฌใ
diff --git a/docs/zh/docs/tutorial/dependencies/classes-as-dependencies.md b/docs/zh/docs/tutorial/dependencies/classes-as-dependencies.md
index f404820df..1866da298 100644
--- a/docs/zh/docs/tutorial/dependencies/classes-as-dependencies.md
+++ b/docs/zh/docs/tutorial/dependencies/classes-as-dependencies.md
@@ -12,7 +12,7 @@
{!> ../../../docs_src/dependencies/tutorial001_py310.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="9"
{!> ../../../docs_src/dependencies/tutorial001.py!}
@@ -85,7 +85,7 @@ fluffy = Cat(name="Mr Fluffy")
{!> ../../../docs_src/dependencies/tutorial002_py310.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="11-15"
{!> ../../../docs_src/dependencies/tutorial002.py!}
diff --git a/docs/zh/docs/tutorial/encoder.md b/docs/zh/docs/tutorial/encoder.md
index 76ed846ce..859ebc2e8 100644
--- a/docs/zh/docs/tutorial/encoder.md
+++ b/docs/zh/docs/tutorial/encoder.md
@@ -26,7 +26,7 @@
{!> ../../../docs_src/encoder/tutorial001_py310.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="5 22"
{!> ../../../docs_src/encoder/tutorial001.py!}
diff --git a/docs/zh/docs/tutorial/extra-data-types.md b/docs/zh/docs/tutorial/extra-data-types.md
index 76d606903..a74efa61b 100644
--- a/docs/zh/docs/tutorial/extra-data-types.md
+++ b/docs/zh/docs/tutorial/extra-data-types.md
@@ -67,7 +67,7 @@
{!> ../../../docs_src/extra_data_types/tutorial001_an_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="1 3 13-17"
{!> ../../../docs_src/extra_data_types/tutorial001_an.py!}
@@ -82,7 +82,7 @@
{!> ../../../docs_src/extra_data_types/tutorial001_py310.py!}
```
-=== "Python 3.6+ non-Annotated"
+=== "Python 3.8+ non-Annotated"
!!! tip
ๅฐฝๅฏ่ฝ้ๆฉไฝฟ็จ `Annotated` ็็ๆฌใ
@@ -105,7 +105,7 @@
{!> ../../../docs_src/extra_data_types/tutorial001_an_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="19-20"
{!> ../../../docs_src/extra_data_types/tutorial001_an.py!}
@@ -120,7 +120,7 @@
{!> ../../../docs_src/extra_data_types/tutorial001_py310.py!}
```
-=== "Python 3.6+ non-Annotated"
+=== "Python 3.8+ non-Annotated"
!!! tip
ๅฐฝๅฏ่ฝ้ๆฉไฝฟ็จ `Annotated` ็็ๆฌใ
diff --git a/docs/zh/docs/tutorial/extra-models.md b/docs/zh/docs/tutorial/extra-models.md
index 32f8f9df1..06427a73d 100644
--- a/docs/zh/docs/tutorial/extra-models.md
+++ b/docs/zh/docs/tutorial/extra-models.md
@@ -23,7 +23,7 @@
{!> ../../../docs_src/extra_models/tutorial001_py310.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="9 11 16 22 24 29-30 33-35 40-41"
{!> ../../../docs_src/extra_models/tutorial001.py!}
@@ -164,7 +164,7 @@ UserInDB(
{!> ../../../docs_src/extra_models/tutorial002_py310.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="9 15-16 19-20 23-24"
{!> ../../../docs_src/extra_models/tutorial002.py!}
@@ -188,7 +188,7 @@ UserInDB(
{!> ../../../docs_src/extra_models/tutorial003_py310.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="1 14-15 18-20 33"
{!> ../../../docs_src/extra_models/tutorial003.py!}
@@ -206,7 +206,7 @@ UserInDB(
{!> ../../../docs_src/extra_models/tutorial004_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="1 20"
{!> ../../../docs_src/extra_models/tutorial004.py!}
@@ -226,7 +226,7 @@ UserInDB(
{!> ../../../docs_src/extra_models/tutorial005_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="1 8"
{!> ../../../docs_src/extra_models/tutorial005.py!}
diff --git a/docs/zh/docs/tutorial/header-params.md b/docs/zh/docs/tutorial/header-params.md
index 22ff6dc27..2701167b3 100644
--- a/docs/zh/docs/tutorial/header-params.md
+++ b/docs/zh/docs/tutorial/header-params.md
@@ -18,7 +18,7 @@
{!> ../../../docs_src/header_params/tutorial001_an_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="3"
{!> ../../../docs_src/header_params/tutorial001_an.py!}
@@ -33,7 +33,7 @@
{!> ../../../docs_src/header_params/tutorial001_py310.py!}
```
-=== "Python 3.6+ non-Annotated"
+=== "Python 3.8+ non-Annotated"
!!! tip
ๅฐฝๅฏ่ฝ้ๆฉไฝฟ็จ `Annotated` ็็ๆฌใ
@@ -60,7 +60,7 @@
{!> ../../../docs_src/header_params/tutorial001_an_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="10"
{!> ../../../docs_src/header_params/tutorial001_an.py!}
@@ -75,7 +75,7 @@
{!> ../../../docs_src/header_params/tutorial001_py310.py!}
```
-=== "Python 3.6+ non-Annotated"
+=== "Python 3.8+ non-Annotated"
!!! tip
ๅฐฝๅฏ่ฝ้ๆฉไฝฟ็จ `Annotated` ็็ๆฌใ
@@ -120,7 +120,7 @@
{!> ../../../docs_src/header_params/tutorial002_an_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="12"
{!> ../../../docs_src/header_params/tutorial002_an.py!}
@@ -135,7 +135,7 @@
{!> ../../../docs_src/header_params/tutorial002_py310.py!}
```
-=== "Python 3.6+ non-Annotated"
+=== "Python 3.8+ non-Annotated"
!!! tip
ๅฐฝๅฏ่ฝ้ๆฉไฝฟ็จ `Annotated` ็็ๆฌใ
@@ -170,7 +170,7 @@
{!> ../../../docs_src/header_params/tutorial003_an_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="10"
{!> ../../../docs_src/header_params/tutorial003_an.py!}
@@ -194,7 +194,7 @@
{!> ../../../docs_src/header_params/tutorial003_py39.py!}
```
-=== "Python 3.6+ non-Annotated"
+=== "Python 3.8+ non-Annotated"
!!! tip
ๅฐฝๅฏ่ฝ้ๆฉไฝฟ็จ `Annotated` ็็ๆฌใ
diff --git a/docs/zh/docs/tutorial/path-params-numeric-validations.md b/docs/zh/docs/tutorial/path-params-numeric-validations.md
index 78fa922b4..9b41ad7cf 100644
--- a/docs/zh/docs/tutorial/path-params-numeric-validations.md
+++ b/docs/zh/docs/tutorial/path-params-numeric-validations.md
@@ -18,7 +18,7 @@
{!> ../../../docs_src/path_params_numeric_validations/tutorial001_an_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="3-4"
{!> ../../../docs_src/path_params_numeric_validations/tutorial001_an.py!}
@@ -33,7 +33,7 @@
{!> ../../../docs_src/path_params_numeric_validations/tutorial001_py310.py!}
```
-=== "Python 3.6+ non-Annotated"
+=== "Python 3.8+ non-Annotated"
!!! tip
ๅฐฝๅฏ่ฝ้ๆฉไฝฟ็จ `Annotated` ็็ๆฌใ
@@ -60,7 +60,7 @@
{!> ../../../docs_src/path_params_numeric_validations/tutorial001_an_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="11"
{!> ../../../docs_src/path_params_numeric_validations/tutorial001_an.py!}
@@ -75,7 +75,7 @@
{!> ../../../docs_src/path_params_numeric_validations/tutorial001_py310.py!}
```
-=== "Python 3.6+ non-Annotated"
+=== "Python 3.8+ non-Annotated"
!!! tip
ๅฐฝๅฏ่ฝ้ๆฉไฝฟ็จ `Annotated` ็็ๆฌใ
@@ -107,7 +107,7 @@
ๅ ๆญค๏ผไฝ ๅฏไปฅๅฐๅฝๆฐๅฃฐๆไธบ๏ผ
-=== "Python 3.6 non-Annotated"
+=== "Python 3.8 non-Annotated"
!!! tip
ๅฐฝๅฏ่ฝ้ๆฉไฝฟ็จ `Annotated` ็็ๆฌใ
diff --git a/docs/zh/docs/tutorial/query-params-str-validations.md b/docs/zh/docs/tutorial/query-params-str-validations.md
index 7244aeade..39253eb0d 100644
--- a/docs/zh/docs/tutorial/query-params-str-validations.md
+++ b/docs/zh/docs/tutorial/query-params-str-validations.md
@@ -10,7 +10,7 @@
{!> ../../../docs_src/query_params_str_validations/tutorial001_py310.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="9"
{!> ../../../docs_src/query_params_str_validations/tutorial001.py!}
diff --git a/docs/zh/docs/tutorial/request-files.md b/docs/zh/docs/tutorial/request-files.md
index 03474907e..2c48f33ca 100644
--- a/docs/zh/docs/tutorial/request-files.md
+++ b/docs/zh/docs/tutorial/request-files.md
@@ -130,7 +130,7 @@ contents = myfile.file.read()
{!> ../../../docs_src/request_files/tutorial001_02_py310.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="9 17"
{!> ../../../docs_src/request_files/tutorial001_02.py!}
@@ -158,7 +158,7 @@ FastAPI ๆฏๆๅๆถไธไผ ๅคไธชๆไปถใ
{!> ../../../docs_src/request_files/tutorial002_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="10 15"
{!> ../../../docs_src/request_files/tutorial002.py!}
@@ -183,7 +183,7 @@ FastAPI ๆฏๆๅๆถไธไผ ๅคไธชๆไปถใ
{!> ../../../docs_src/request_files/tutorial003_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="18"
{!> ../../../docs_src/request_files/tutorial003.py!}
diff --git a/docs/zh/docs/tutorial/response-model.md b/docs/zh/docs/tutorial/response-model.md
index f529cb0d8..e731b6989 100644
--- a/docs/zh/docs/tutorial/response-model.md
+++ b/docs/zh/docs/tutorial/response-model.md
@@ -20,7 +20,7 @@
{!> ../../../docs_src/response_model/tutorial001_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="17 22 24-27"
{!> ../../../docs_src/response_model/tutorial001.py!}
@@ -78,7 +78,7 @@ FastAPI ๅฐไฝฟ็จๆญค `response_model` ๆฅ๏ผ
{!> ../../../docs_src/response_model/tutorial003_py310.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="9 11 16"
{!> ../../../docs_src/response_model/tutorial003.py!}
@@ -92,7 +92,7 @@ FastAPI ๅฐไฝฟ็จๆญค `response_model` ๆฅ๏ผ
{!> ../../../docs_src/response_model/tutorial003_py310.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="24"
{!> ../../../docs_src/response_model/tutorial003.py!}
@@ -106,7 +106,7 @@ FastAPI ๅฐไฝฟ็จๆญค `response_model` ๆฅ๏ผ
{!> ../../../docs_src/response_model/tutorial003_py310.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="22"
{!> ../../../docs_src/response_model/tutorial003.py!}
diff --git a/docs/zh/docs/tutorial/schema-extra-example.md b/docs/zh/docs/tutorial/schema-extra-example.md
index 816e8f68e..ebc04da8b 100644
--- a/docs/zh/docs/tutorial/schema-extra-example.md
+++ b/docs/zh/docs/tutorial/schema-extra-example.md
@@ -16,7 +16,7 @@
{!> ../../../docs_src/schema_extra_example/tutorial001_py310.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="15-23"
{!> ../../../docs_src/schema_extra_example/tutorial001.py!}
@@ -34,7 +34,7 @@
{!> ../../../docs_src/schema_extra_example/tutorial002_py310.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="4 10-13"
{!> ../../../docs_src/schema_extra_example/tutorial002.py!}
@@ -61,7 +61,7 @@
{!> ../../../docs_src/schema_extra_example/tutorial003_an_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="23-28"
{!> ../../../docs_src/schema_extra_example/tutorial003_an.py!}
@@ -76,7 +76,7 @@
{!> ../../../docs_src/schema_extra_example/tutorial003_py310.py!}
```
-=== "Python 3.6+ non-Annotated"
+=== "Python 3.8+ non-Annotated"
!!! tip
ๅฐฝๅฏ่ฝ้ๆฉไฝฟ็จ `Annotated` ็็ๆฌใ
diff --git a/docs/zh/docs/tutorial/security/first-steps.md b/docs/zh/docs/tutorial/security/first-steps.md
index 7b1052e12..dda956417 100644
--- a/docs/zh/docs/tutorial/security/first-steps.md
+++ b/docs/zh/docs/tutorial/security/first-steps.md
@@ -26,13 +26,13 @@
{!> ../../../docs_src/security/tutorial001_an_py39.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python
{!> ../../../docs_src/security/tutorial001_an.py!}
```
-=== "Python 3.6+ non-Annotated"
+=== "Python 3.8+ non-Annotated"
!!! tip
ๅฐฝๅฏ่ฝ้ๆฉไฝฟ็จ `Annotated` ็็ๆฌใ
diff --git a/docs/zh/docs/tutorial/security/simple-oauth2.md b/docs/zh/docs/tutorial/security/simple-oauth2.md
index 276f3d63b..c7f46177f 100644
--- a/docs/zh/docs/tutorial/security/simple-oauth2.md
+++ b/docs/zh/docs/tutorial/security/simple-oauth2.md
@@ -1,94 +1,98 @@
-# ไฝฟ็จๅฏ็ ๅ Bearer ็็ฎๅ OAuth2
+# OAuth2 ๅฎ็ฐ็ฎๅ็ Password ๅ Bearer ้ช่ฏ
-็ฐๅจ่ฎฉๆไปฌๆฅ็ไธไธ็ซ ็ปง็ปญๅผๅ๏ผๅนถๆทปๅ ็ผบๅฐ็้จๅไปฅๅฎ็ฐไธไธชๅฎๆด็ๅฎๅ
จๆงๆต็จใ
+ๆฌ็ซ ๆทปๅ ไธไธ็ซ ็คบไพไธญๆฌ ็ผบ็้จๅ๏ผๅฎ็ฐๅฎๆด็ๅฎๅ
จๆตใ
## ่ทๅ `username` ๅ `password`
-ๆไปฌๅฐไฝฟ็จ **FastAPI** ็ๅฎๅ
จๆงๅฎ็จๅทฅๅ
ทๆฅ่ทๅ `username` ๅ `password`ใ
+้ฆๅ
๏ผไฝฟ็จ **FastAPI** ๅฎๅ
จๅทฅๅ
ท่ทๅ `username` ๅ `password`ใ
-OAuth2 ่งๅฎๅจไฝฟ็จ๏ผๆไปฌๆ็ฎ็จ็๏ผใpassword ๆต็จใๆถ๏ผๅฎขๆท็ซฏ/็จๆทๅฟ
้กปๅฐ `username` ๅ `password` ๅญๆฎตไฝไธบ่กจๅๆฐๆฎๅ้ใ
+OAuth2 ่ง่่ฆๆฑไฝฟ็จ**ๅฏ็ ๆต**ๆถ๏ผๅฎขๆท็ซฏๆ็จๆทๅฟ
้กปไปฅ่กจๅๆฐๆฎๅฝขๅผๅ้ `username` ๅ `password` ๅญๆฎตใ
-่ไธ่ง่ๆ็กฎไบๅญๆฎตๅฟ
้กป่ฟๆ ทๅฝๅใๅ ๆญค `user-name` ๆ `email` ๆฏ่กไธ้็ใ
+ๅนถไธ๏ผ่ฟไธคไธชๅญๆฎตๅฟ
้กปๅฝๅไธบ `username` ๅ `password` ๏ผไธ่ฝไฝฟ็จ `user-name` ๆ `email` ็ญๅ
ถๅฎๅ็งฐใ
-ไธ่ฟไธ็จๆ
ๅฟ๏ผไฝ ๅฏไปฅๅจๅ็ซฏๆ็
งไฝ ็ๆณๆณๅฐๅฎๅฑ็คบ็ปๆ็ป็จๆทใ
+ไธ่ฟไนไธ็จๆ
ๅฟ๏ผๅ็ซฏไปๅฏไปฅๆพ็คบ็ป็ซฏ็จๆทๆ้็ๅ็งฐใ
-่ไธไฝ ็ๆฐๆฎๅบๆจกๅไนๅฏไปฅไฝฟ็จไฝ ๆณ็จ็ไปปไฝๅ
ถไปๅ็งฐใ
+ๆฐๆฎๅบๆจกๅไนๅฏไปฅไฝฟ็จๆ้็ๅ็งฐใ
-ไฝๆฏๅฏนไบ็ปๅฝ*่ทฏๅพๆไฝ*๏ผๆไปฌ้่ฆไฝฟ็จ่ฟไบๅ็งฐๆฅไธ่ง่ๅ
ผๅฎน๏ผไปฅๅ
ทๅคไพๅฆไฝฟ็จ้ๆ็ API ๆๆกฃ็ณป็ป็่ฝๅ๏ผใ
+ไฝๅฏนไบ็ปๅฝ*่ทฏๅพๆไฝ*๏ผๅ่ฆไฝฟ็จๅ
ผๅฎน่ง่็ `username` ๅ `password`๏ผ๏ผไพๅฆ๏ผๅฎ็ฐไธ API ๆๆกฃ้ๆ๏ผใ
-่ง่่ฟๅๆไบ `username` ๅ `password` ๅฟ
้กปไฝไธบ่กจๅๆฐๆฎๅ้๏ผๅ ๆญค๏ผๆญคๅคไธ่ฝไฝฟ็จ JSON๏ผใ
+่ฏฅ่ง่่ฆๆฑๅฟ
้กปไปฅ่กจๅๆฐๆฎๅฝขๅผๅ้ `username` ๅ `password`๏ผๅ ๆญค๏ผไธ่ฝไฝฟ็จ JSON ๅฏน่ฑกใ
-### `scope`
+### `Scope`๏ผไฝ็จๅ๏ผ
-่ง่่ฟๆๅฐๅฎขๆท็ซฏๅฏไปฅๅ้ๅฆไธไธช่กจๅๅญๆฎตใ`scope`ใใ
+OAuth2 ่ฟๆฏๆๅฎขๆท็ซฏๅ้**`scope`**่กจๅๅญๆฎตใ
-่ฟไธช่กจๅๅญๆฎต็ๅ็งฐไธบ `scope`๏ผๅๆฐๅฝขๅผ๏ผ๏ผไฝๅฎ้
ไธๅฎๆฏไธไธช็ฑ็ฉบๆ ผๅ้็ใไฝ็จๅใ็ปๆ็้ฟๅญ็ฌฆไธฒใ
+่ฝ็ถ่กจๅๅญๆฎต็ๅ็งฐๆฏ `scope`๏ผๅๆฐ๏ผ๏ผไฝๅฎ้
ไธ๏ผๅฎๆฏไปฅ็ฉบๆ ผๅ้็๏ผ็ฑๅคไธช**scope**็ปๆ็้ฟๅญ็ฌฆไธฒใ
-ๆฏไธชใไฝ็จๅใๅชๆฏไธไธชๅญ็ฌฆไธฒ๏ผไธญ้ดๆฒกๆ็ฉบๆ ผ๏ผใ
+**ไฝ็จๅ**ๅชๆฏไธๅธฆ็ฉบๆ ผ็ๅญ็ฌฆไธฒใ
-ๅฎไปฌ้ๅธธ็จไบๅฃฐๆ็นๅฎ็ๅฎๅ
จๆ้๏ผไพๅฆ๏ผ
+ๅธธ็จไบๅฃฐๆๆๅฎๅฎๅ
จๆ้๏ผไพๅฆ๏ผ
-* `users:read` ๆ่
`users:write` ๆฏๅธธ่ง็ไพๅญใ
-* Facebook / Instagram ไฝฟ็จ `instagram_basic`ใ
-* Google ไฝฟ็จไบ `https://www.googleapis.com/auth/drive` ใ
+* ๅธธ่ง็จไพไธบ๏ผ`users:read` ๆ `users:write`
+* ่ธไนฆๅ Instagram ไฝฟ็จ `instagram_basic`
+* ่ฐทๆญไฝฟ็จ `https://www.googleapis.com/auth/drive`
-!!! info
- ๅจ OAuth2 ไธญใไฝ็จๅใๅชๆฏไธไธชๅฃฐๆๆ้็นๅฎๆ้็ๅญ็ฌฆไธฒใ
+!!! info "่ฏดๆ"
- ๅฎๆๆฒกๆ `:` ่ฟๆ ท็ๅ
ถไปๅญ็ฌฆๆ่
ๆฏไธๆฏ URL ้ฝๆฒกๆๅ
ณ็ณปใ
+ OAuth2 ไธญ๏ผ**ไฝ็จๅ**ๅชๆฏๅฃฐๆๆๅฎๆ้็ๅญ็ฌฆไธฒใ
- ่ฟไบ็ป่ๆฏๅ
ทไฝ็ๅฎ็ฐใ
+ ๆฏๅฆไฝฟ็จๅๅท `:` ็ญ็ฌฆๅท๏ผๆๆฏไธๆฏ URL ๅนถไธ้่ฆใ
- ๅฏน OAuth2 ๆฅ่ฏดๅฎไปฌๅฐฑๅชๆฏๅญ็ฌฆไธฒ่ๅทฒใ
+ ่ฟไบ็ป่ๅชๆฏ็นๅฎ็ๅฎ็ฐๆนๅผใ
+
+ ๅฏน OAuth2 ๆฅ่ฏด๏ผ้ฝๅชๆฏๅญ็ฌฆไธฒ่ๅทฒใ
## ่ทๅ `username` ๅ `password` ็ไปฃ็
-็ฐๅจ๏ผ่ฎฉๆไปฌไฝฟ็จ **FastAPI** ๆไพ็ๅฎ็จๅทฅๅ
ทๆฅๅค็ๆญค้ฎ้ขใ
+ๆฅไธๆฅ๏ผไฝฟ็จ **FastAPI** ๅทฅๅ
ท่ทๅ็จๆทๅไธๅฏ็ ใ
### `OAuth2PasswordRequestForm`
-้ฆๅ
๏ผๅฏผๅ
ฅ `OAuth2PasswordRequestForm`๏ผ็ถๅๅจ `token` ็*่ทฏๅพๆไฝ*ไธญ้่ฟ `Depends` ๅฐๅ
ถไฝไธบไพ่ต้กนไฝฟ็จใ
+้ฆๅ
๏ผๅฏผๅ
ฅ `OAuth2PasswordRequestForm`๏ผ็ถๅ๏ผๅจ `/token` *่ทฏๅพๆไฝ* ไธญ๏ผ็จ `Depends` ๆ่ฏฅ็ฑปไฝไธบไพ่ต้กนใ
```Python hl_lines="4 76"
{!../../../docs_src/security/tutorial003.py!}
```
-`OAuth2PasswordRequestForm` ๆฏไธไธช็ฑปไพ่ต้กน๏ผๅฃฐๆไบๅฆไธ็่ฏทๆฑ่กจๅ๏ผ
+`OAuth2PasswordRequestForm` ๆฏ็จไปฅไธๅ ้กนๅ
ๅฎนๅฃฐๆ่กจๅ่ฏทๆฑไฝ็็ฑปไพ่ต้กน๏ผ
-* `username`ใ
-* `password`ใ
-* ไธไธชๅฏ้็ `scope` ๅญๆฎต๏ผๆฏไธไธช็ฑ็ฉบๆ ผๅ้็ๅญ็ฌฆไธฒ็ปๆ็ๅคงๅญ็ฌฆไธฒใ
-* ไธไธชๅฏ้็ `grant_type`.
+* `username`
+* `password`
+* ๅฏ้็ `scope` ๅญๆฎต๏ผ็ฑๅคไธช็ฉบๆ ผๅ้็ๅญ็ฌฆไธฒ็ปๆ็้ฟๅญ็ฌฆไธฒ
+* ๅฏ้็ `grant_type`
-!!! tip
- OAuth2 ่ง่ๅฎ้
ไธ*่ฆๆฑ* `grant_type` ๅญๆฎตไฝฟ็จไธไธชๅบๅฎ็ๅผ `password`๏ผไฝๆฏ `OAuth2PasswordRequestForm` ๆฒกๆไฝๅผบๅถ็บฆๆใ
+!!! tip "ๆ็คบ"
- ๅฆๆไฝ ้่ฆๅผบๅถ่ฆๆฑ่ฟไธ็น๏ผ่ฏทไฝฟ็จ `OAuth2PasswordRequestFormStrict` ่ไธๆฏ `OAuth2PasswordRequestForm`ใ
+ ๅฎ้
ไธ๏ผOAuth2 ่ง่*่ฆๆฑ* `grant_type` ๅญๆฎตไฝฟ็จๅบๅฎๅผ `password`๏ผไฝ `OAuth2PasswordRequestForm` ๆฒกๆไฝๅผบๅถ็บฆๆใ
-* ไธไธชๅฏ้็ `client_id`๏ผๆไปฌ็็คบไพไธ้่ฆๅฎ๏ผใ
-* ไธไธชๅฏ้็ `client_secret`๏ผๆไปฌ็็คบไพไธ้่ฆๅฎ๏ผใ
+ ๅฆ้ๅผบๅถไฝฟ็จๅบๅฎๅผ `password`๏ผๅไธ่ฆ็จ `OAuth2PasswordRequestForm`๏ผ่ๆฏ็จ `OAuth2PasswordRequestFormStrict`ใ
-!!! info
- `OAuth2PasswordRequestForm` ๅนถไธๅ `OAuth2PasswordBearer` ไธๆ ทๆฏ FastAPI ็ไธไธช็นๆฎ็็ฑปใ
+* ๅฏ้็ `client_id`๏ผๆฌไพๆชไฝฟ็จ๏ผ
+* ๅฏ้็ `client_secret`๏ผๆฌไพๆชไฝฟ็จ๏ผ
- `OAuth2PasswordBearer` ไฝฟๅพ **FastAPI** ๆ็ฝๅฎๆฏไธไธชๅฎๅ
จๆนๆกใๆไปฅๅฎๅพไปฅ้่ฟ่ฟ็งๆนๅผๆทปๅ ๅฐ OpenAPI ไธญใ
+!!! info "่ฏดๆ"
- ไฝ `OAuth2PasswordRequestForm` ๅชๆฏไธไธชไฝ ๅฏไปฅ่ชๅทฑ็ผๅ็็ฑปไพ่ต้กน๏ผๆ่
ไฝ ไนๅฏไปฅ็ดๆฅๅฃฐๆ `Form` ๅๆฐใ
+ `OAuth2PasswordRequestForm` ไธ `OAuth2PasswordBearer` ไธๆ ท๏ผ้ฝไธๆฏ FastAPI ็็นๆฎ็ฑปใ
- ไฝๆฏ็ฑไบ่ฟๆฏไธ็งๅธธ่ง็ไฝฟ็จๅบๆฏ๏ผๅ ๆญค FastAPI ๅบไบ็ฎไพฟ็ดๆฅๆไพไบๅฎใ
+ **FastAPI** ๆ `OAuth2PasswordBearer` ่ฏๅซไธบๅฎๅ
จๆนๆกใๅ ๆญค๏ผๅฏไปฅ้่ฟ่ฟ็งๆนๅผๆๅฎๆทปๅ ่ณ OpenAPIใ
+
+ ไฝ `OAuth2PasswordRequestForm` ๅชๆฏๅฏไปฅ่ช่ก็ผๅ็็ฑปไพ่ต้กน๏ผไนๅฏไปฅ็ดๆฅๅฃฐๆ `Form` ๅๆฐใ
+
+ ไฝ็ฑไบ่ฟ็ง็จไพๅพๅธธ่ง๏ผFastAPI ไธบไบ็ฎไพฟ๏ผๅฐฑ็ดๆฅๆไพไบๅฏนๅฎ็ๆฏๆใ
### ไฝฟ็จ่กจๅๆฐๆฎ
-!!! tip
- ็ฑปไพ่ต้กน `OAuth2PasswordRequestForm` ็ๅฎไพไธไผๆ็จ็ฉบๆ ผๅ้็้ฟๅญ็ฌฆไธฒๅฑๆง `scope`๏ผ่ๆฏๅ
ทๆไธไธช `scopes` ๅฑๆง๏ผ่ฏฅๅฑๆงๅฐๅ
ๅซๅฎ้
่ขซๅ้็ๆฏไธชไฝ็จๅๅญ็ฌฆไธฒ็ปๆ็ๅ่กจใ
+!!! tip "ๆ็คบ"
- ๅจๆญค็คบไพไธญๆไปฌๆฒกๆไฝฟ็จ `scopes`๏ผไฝๅฆๆไฝ ้่ฆ็่ฏๅฏไปฅไฝฟ็จ่ฏฅๅ่ฝใ
+ `OAuth2PasswordRequestForm` ็ฑปไพ่ต้กน็ๅฎไพๆฒกๆไปฅ็ฉบๆ ผๅ้็้ฟๅญ็ฌฆไธฒๅฑๆง `scope`๏ผไฝๅฎๆฏๆ `scopes` ๅฑๆง๏ผ็ฑๅทฒๅ้็ scope ๅญ็ฌฆไธฒๅ่กจ็ปๆใ
-็ฐๅจ๏ผไฝฟ็จ่กจๅๅญๆฎตไธญ็ `username` ไป๏ผไผช๏ผๆฐๆฎๅบไธญ่ทๅ็จๆทๆฐๆฎใ
+ ๆฌไพๆฒกๆไฝฟ็จ `scopes`๏ผไฝๅผๅ่
ไนๅฏไปฅๆ นๆฎ้่ฆไฝฟ็จ่ฏฅๅฑๆงใ
-ๅฆๆๆฒกๆ่ฟไธช็จๆท๏ผๆไปฌๅฐ่ฟๅไธไธช้่ฏฏๆถๆฏ๏ผๆ็คบใ็จๆทๅๆๅฏ็ ้่ฏฏใใ
+็ฐๅจ๏ผๅณๅฏไฝฟ็จ่กจๅๅญๆฎต `username`๏ผไป๏ผไผช๏ผๆฐๆฎๅบไธญ่ทๅ็จๆทๆฐๆฎใ
-ๅฏนไบ่ฟไธช้่ฏฏ๏ผๆไปฌไฝฟ็จ `HTTPException` ๅผๅธธ๏ผ
+ๅฆๆไธๅญๅจๆๅฎ็จๆท๏ผๅ่ฟๅ้่ฏฏๆถๆฏ๏ผๆ็คบ**็จๆทๅๆๅฏ็ ้่ฏฏ**ใ
+
+ๆฌไพไฝฟ็จ `HTTPException` ๅผๅธธๆพ็คบๆญค้่ฏฏ๏ผ
```Python hl_lines="3 77-79"
{!../../../docs_src/security/tutorial003.py!}
@@ -96,27 +100,27 @@ OAuth2 ่งๅฎๅจไฝฟ็จ๏ผๆไปฌๆ็ฎ็จ็๏ผใpassword ๆต็จใๆถ๏ผๅฎขๆท
### ๆ ก้ชๅฏ็
-็ฎๅๆไปฌๅทฒ็ปไปๆฐๆฎๅบไธญ่ทๅไบ็จๆทๆฐๆฎ๏ผไฝๅฐๆชๆ ก้ชๅฏ็ ใ
+่ณๆญค๏ผๆไปฌๅทฒ็ปไปๆฐๆฎๅบไธญ่ทๅไบ็จๆทๆฐๆฎ๏ผไฝๅฐๆชๆ ก้ชๅฏ็ ใ
-่ฎฉๆไปฌ้ฆๅ
ๅฐ่ฟไบๆฐๆฎๆพๅ
ฅ Pydantic `UserInDB` ๆจกๅไธญใ
+ๆฅไธๆฅ๏ผ้ฆๅ
ๅฐๆฐๆฎๆพๅ
ฅ Pydantic ็ `UserInDB` ๆจกๅใ
-ๆฐธ่ฟไธ่ฆไฟๅญๆๆๅฏ็ ๏ผๅ ๆญค๏ผๆไปฌๅฐไฝฟ็จ๏ผไผช๏ผๅๅธๅฏ็ ็ณป็ปใ
+ๆณจๆ๏ผๆฐธ่ฟไธ่ฆไฟๅญๆๆๅฏ็ ๏ผๆฌไพๆๆถๅ
ไฝฟ็จ๏ผไผช๏ผๅๅธๅฏ็ ็ณป็ปใ
-ๅฆๆๅฏ็ ไธๅน้
๏ผๆไปฌๅฐ่ฟๅๅไธไธช้่ฏฏใ
+ๅฆๆๅฏ็ ไธๅน้
๏ผๅ่ฟๅไธไธ้ข็ธๅ็้่ฏฏใ
-#### ๅๅธๅฏ็
+#### ๅฏ็ ๅๅธ
-ใๅๅธใ็ๆๆๆฏ๏ผๅฐๆไบๅ
ๅฎน๏ผๅจๆฌไพไธญไธบๅฏ็ ๏ผ่ฝฌๆขไธบ็่ตทๆฅๅไนฑ็ ็ๅญ่ๅบๅ๏ผๅชๆฏไธไธชๅญ็ฌฆไธฒ๏ผใ
+**ๅๅธ**ๆฏๆ๏ผๅฐๆๅฎๅ
ๅฎน๏ผๆฌไพไธญไธบๅฏ็ ๏ผ่ฝฌๆขไธบๅฝขไผผไนฑ็ ็ๅญ่ๅบๅ๏ผๅ
ถๅฎๅฐฑๆฏๅญ็ฌฆไธฒ๏ผใ
-ๆฏๆฌกไฝ ไผ ๅ
ฅๅฎๅ
จ็ธๅ็ๅ
ๅฎน๏ผๅฎๅ
จ็ธๅ็ๅฏ็ ๏ผๆถ๏ผไฝ ้ฝไผๅพๅฐๅฎๅ
จ็ธๅ็ไนฑ็ ใ
+ๆฏๆฌกไผ ๅ
ฅๅฎๅ
จ็ธๅ็ๅ
ๅฎน๏ผๆฏๅฆ๏ผๅฎๅ
จ็ธๅ็ๅฏ็ ๏ผๆถ๏ผๅพๅฐ็้ฝๆฏๅฎๅ
จ็ธๅ็ไนฑ็ ใ
-ไฝๆฏไฝ ไธ่ฝไปไนฑ็ ่ฝฌๆขๅๅฏ็ ใ
+ไฝ่ฟไธชไนฑ็ ๆ ๆณ่ฝฌๆขๅไผ ๅ
ฅ็ๅฏ็ ใ
-##### ไธบไปไนไฝฟ็จๅๅธๅฏ็
+##### ไธบไปไนไฝฟ็จๅฏ็ ๅๅธ
-ๅฆๆไฝ ็ๆฐๆฎๅบ่ขซ็๏ผๅฐๅทๅฐๆ ๆณ่ทๅพ็จๆท็ๆๆๅฏ็ ๏ผๅชๆๅๅธๅผใ
+ๅๅ ๅพ็ฎๅ๏ผๅๅฆๆฐๆฎๅบ่ขซ็๏ผ็ช่ดผๆ ๆณ่ทๅ็จๆท็ๆๆๅฏ็ ๏ผๅพๅฐ็ๅชๆฏๅๅธๅผใ
-ๅ ๆญค๏ผๅฐๅทๅฐๆ ๆณๅฐ่ฏๅจๅฆไธไธช็ณป็ปไธญไฝฟ็จ่ฟไบ็ธๅ็ๅฏ็ ๏ผ็ฑไบ่ฎธๅค็จๆทๅจไปปไฝๅฐๆน้ฝไฝฟ็จ็ธๅ็ๅฏ็ ๏ผๅ ๆญค่ฟๅพๅฑ้ฉ๏ผใ
+่ฟๆ ทไธๆฅ๏ผ็ช่ดผๅฐฑๆ ๆณๅจๅ
ถๅฎๅบ็จไธญไฝฟ็จ็ชๅ็ๅฏ็ ๏ผ่ฆ็ฅ้๏ผๅพๅค็จๆทๅจๆๆ็ณป็ปไธญ้ฝไฝฟ็จ็ธๅ็ๅฏ็ ๏ผ้ฃ้ฉ่ถ
ๅคงใ
```Python hl_lines="80-83"
{!../../../docs_src/security/tutorial003.py!}
@@ -124,9 +128,9 @@ OAuth2 ่งๅฎๅจไฝฟ็จ๏ผๆไปฌๆ็ฎ็จ็๏ผใpassword ๆต็จใๆถ๏ผๅฎขๆท
#### ๅ
ณไบ `**user_dict`
-`UserInDB(**user_dict)` ่กจ็คบ๏ผ
+`UserInDB(**user_dict)` ๆฏๆ๏ผ
-*็ดๆฅๅฐ `user_dict` ็้ฎๅๅผไฝไธบๅ
ณ้ฎๅญๅๆฐไผ ้๏ผ็ญๅไบ๏ผ*
+*็ดๆฅๆ `user_dict` ็้ฎไธๅผๅฝไฝๅ
ณ้ฎๅญๅๆฐไผ ้๏ผ็ญๆไบ๏ผ*
```Python
UserInDB(
@@ -138,75 +142,79 @@ UserInDB(
)
```
-!!! info
- ๆๅ
ณ `user_dict` ็ๆดๅฎๆด่ฏดๆ๏ผ่ฏทๅ้
[**้ขๅค็ๆจกๅ**ๆๆกฃ](../extra-models.md#about-user_indict){.internal-link target=_blank}ใ
+!!! info "่ฏดๆ"
-## ่ฟๅไปค็
+ `user_dict` ็่ฏดๆ๏ผ่ฏฆ่ง[**ๆดๅคๆจกๅ**ไธ็ซ ](../extra-models.md#about-user_indict){.internal-link target=_blank}ใ
-`token` ็ซฏ็น็ๅๅบๅฟ
้กปๆฏไธไธช JSON ๅฏน่ฑกใ
+## ่ฟๅ Token
-ๅฎๅบ่ฏฅๆไธไธช `token_type`ใๅจๆไปฌ็ไพๅญไธญ๏ผ็ฑไบๆไปฌไฝฟ็จ็ๆฏใBearerใไปค็๏ผๅ ๆญคไปค็็ฑปๅๅบไธบใ`bearer`ใใ
+`token` ็ซฏ็น็ๅๅบๅฟ
้กปๆฏ JSON ๅฏน่ฑกใ
-ๅนถไธ่ฟๅบ่ฏฅๆไธไธช `access_token` ๅญๆฎต๏ผๅฎๆฏไธไธชๅ
ๅซๆไปฌ็่ฎฟ้ฎไปค็็ๅญ็ฌฆไธฒใ
+ๅๅบ่ฟๅ็ๅ
ๅฎนๅบ่ฏฅๅ
ๅซ `token_type`ใๆฌไพไธญ็จ็ๆฏ**Bearer**Token๏ผๅ ๆญค๏ผ Token ็ฑปๅๅบไธบ**`bearer`**ใ
-ๅฏนไบ่ฟไธช็ฎๅ็็คบไพ๏ผๆไปฌๅฐๆๅ
ถไธๅฎๅ
จๅฐ่ฟๅ็ธๅ็ `username` ไฝไธบไปค็ใ
+่ฟๅๅ
ๅฎน่ฟๅบๅ
ๅซ `access_token` ๅญๆฎต๏ผๅฎๆฏๅ
ๅซๆ้ Token ็ๅญ็ฌฆไธฒใ
-!!! tip
- ๅจไธไธ็ซ ไธญ๏ผไฝ ๅฐ็ๅฐไธไธช็ๅฎ็ๅฎๅ
จๅฎ็ฐ๏ผไฝฟ็จไบๅๅธๅฏ็ ๅ JWT ไปค็ใ
+ๆฌไพๅชๆฏ็ฎๅ็ๆผ็คบ๏ผ่ฟๅ็ Token ๅฐฑๆฏ `username`๏ผไฝ่ฟ็งๆนๅผๆไธๅฎๅ
จใ
- ไฝ็ฐๅจ๏ผ่ฎฉๆไปฌไป
ๅ
ณๆณจๆไปฌ้่ฆ็็นๅฎ็ป่ใ
+!!! tip "ๆ็คบ"
+
+ ไธไธ็ซ ไป็ปไฝฟ็จๅๅธๅฏ็ ๅ JWT Token ็็ๆญฃๅฎๅ
จๆบๅถใ
+
+ ไฝ็ฐๅจ๏ผไป
ๅ
ณๆณจๆ้็็นๅฎ็ป่ใ
```Python hl_lines="85"
{!../../../docs_src/security/tutorial003.py!}
```
-!!! tip
- ๆ นๆฎ่ง่๏ผไฝ ๅบ่ฏฅๅๆฌ็คบไพไธๆ ท๏ผ่ฟๅไธไธชๅธฆๆ `access_token` ๅ `token_type` ็ JSONใ
+!!! tip "ๆ็คบ"
- ่ฟๆฏไฝ ๅฟ
้กปๅจไปฃ็ ไธญ่ช่กๅฎๆ็ๅทฅไฝ๏ผๅนถไธ่ฆ็กฎไฟไฝฟ็จไบ่ฟไบ JSON ๅญๆฎตใ
+ ๆ่ง่็่ฆๆฑ๏ผๅบๅๆฌ็คบไพไธๆ ท๏ผ่ฟๅๅธฆๆ `access_token` ๅ `token_type` ็ JSON ๅฏน่ฑกใ
- ่ฟๅ ไนๆฏๅฏไธ็ไฝ ้่ฆ่ชๅทฑ่ฎฐไฝๅนถๆญฃ็กฎๅฐๆง่กไปฅ็ฌฆๅ่ง่็ไบๆ
ใ
+ ่ฟๆฏๅผๅ่
ๅฟ
้กปๅจไปฃ็ ไธญ่ช่กๅฎๆ็ๅทฅไฝ๏ผๅนถไธ่ฆ็กฎไฟไฝฟ็จ่ฟไบ JSON ็้ฎใ
- ๅ
ถไฝ็๏ผ**FastAPI** ้ฝไผไธบไฝ ๅค็ใ
+ ่ฟๅ ไนๆฏๅฏไธ้่ฆๅผๅ่
็ข่ฎฐๅจๅฟ๏ผๅนถๆ่ง่่ฆๆฑๆญฃ็กฎๆง่ก็ไบใ
+
+ **FastAPI** ๅ่ด่ดฃๅค็ๅ
ถๅฎ็ๅทฅไฝใ
## ๆดๆฐไพ่ต้กน
-็ฐๅจๆไปฌๅฐๆดๆฐๆไปฌ็ไพ่ต้กนใ
+ๆฅไธๆฅ๏ผๆดๆฐไพ่ต้กนใ
-ๆไปฌๆณ่ฆไป
ๅฝๆญค็จๆทๅคไบๅฏ็จ็ถๆๆถๆ่ฝ่ทๅ `current_user`ใ
+ไฝฟไนไป
ๅจๅฝๅ็จๆทไธบๆฟๆดป็ถๆๆถ๏ผๆ่ฝ่ทๅ `current_user`ใ
-ๅ ๆญค๏ผๆไปฌๅๅปบไบไธไธช้ขๅค็ไพ่ต้กน `get_current_active_user`๏ผ่่ฏฅไพ่ต้กนๅไปฅ `get_current_user` ไฝไธบไพ่ต้กนใ
+ไธบๆญค๏ผ่ฆๅๅๅปบไธไธชไพ่ต้กน `get_current_active_user`๏ผๆญคไพ่ต้กนไปฅ `get_current_user` ไพ่ต้กนไธบๅบ็กใ
-ๅฆๆ็จๆทไธๅญๅจๆๅคไบๆชๅฏ็จ็ถๆ๏ผๅ่ฟไธคไธชไพ่ต้กน้ฝๅฐไป
่ฟๅ HTTP ้่ฏฏใ
+ๅฆๆ็จๆทไธๅญๅจ๏ผๆ็ถๆไธบๆชๆฟๆดป๏ผ่ฟไธคไธชไพ่ต้กน้ฝไผ่ฟๅ HTTP ้่ฏฏใ
-ๅ ๆญค๏ผๅจๆไปฌ็็ซฏ็นไธญ๏ผๅชๆๅฝ็จๆทๅญๅจ๏ผ่บซไปฝ่ฎค่ฏ้่ฟไธๅคไบๅฏ็จ็ถๆๆถ๏ผๆไปฌๆ่ฝ่ทๅพ่ฏฅ็จๆท๏ผ
+ๅ ๆญค๏ผๅจ็ซฏ็นไธญ๏ผๅชๆๅฝ็จๆทๅญๅจใ้่ฟ่บซไปฝ้ช่ฏใไธ็ถๆไธบๆฟๆดปๆถ๏ผๆ่ฝ่ทๅพ่ฏฅ็จๆท๏ผ
```Python hl_lines="58-67 69-72 90"
{!../../../docs_src/security/tutorial003.py!}
```
-!!! info
- ๆไปฌๅจๆญคๅค่ฟๅ็ๅผไธบ `Bearer` ็้ขๅคๅๅบๅคด `WWW-Authenticate` ไนๆฏ่ง่็ไธ้จๅใ
+!!! info "่ฏดๆ"
- ไปปไฝ็ 401ใๆช่ฎค่ฏใHTTP๏ผ้่ฏฏ๏ผ็ถๆ็ ้ฝๅบ่ฏฅ่ฟๅ `WWW-Authenticate` ๅๅบๅคดใ
+ ๆญคๅค่ฟๅๅผไธบ `Bearer` ็ๅๅบๅคด `WWW-Authenticate` ไนๆฏ่ง่็ไธ้จๅใ
- ๅฏนไบ bearer ไปค็๏ผๆไปฌ็ไพๅญ๏ผ๏ผ่ฏฅๅๅบๅคด็ๅผๅบไธบ `Bearer`ใ
+ ไปปไฝ 401**UNAUTHORIZED**HTTP๏ผ้่ฏฏ๏ผ็ถๆ็ ้ฝๅบ่ฟๅ `WWW-Authenticate` ๅๅบๅคดใ
- ๅฎ้
ไธไฝ ๅฏไปฅๅฟฝ็ฅ่ฟไธช้ขๅค็ๅๅบๅคด๏ผไธไผๆไปไน้ฎ้ขใ
+ ๆฌไพไธญ๏ผๅ ไธบไฝฟ็จ็ๆฏ Bearer Token๏ผ่ฏฅๅๅบๅคด็ๅผๅบไธบ `Bearer`ใ
- ไฝๆญคๅคๆไพไบๅฎไปฅ็ฌฆๅ่ง่ใ
+ ๅฎ้
ไธ๏ผๅฟฝ็ฅ่ฟไธช้ๅ ๅๅบๅคด๏ผไนไธไผๆไปไน้ฎ้ขใ
- ่ไธ๏ผ๏ผ็ฐๅจๆๅฐๆฅ๏ผๅฏ่ฝไผๆๅทฅๅ
ทๆๆๅพๅฐๅนถไฝฟ็จๅฎ๏ผ็ถๅๅฏนไฝ ๆไฝ ็็จๆทๆ็จๅคใ
+ ไนๆไปฅๅจๆญคๆไพ่ฟไธช้ๅ ๅๅบๅคด๏ผๆฏไธบไบ็ฌฆๅ่ง่็่ฆๆฑใ
- ่ฟๅฐฑๆฏ้ตๅพชๆ ๅ็ๅฅฝๅค...
+ ่ฏดไธๅฎไปไนๆถๅ๏ผๅฐฑๆๅทฅๅ
ท็จๅพไธๅฎ๏ผ่ไธ๏ผๅผๅ่
ๆ็จๆทไนๅฏ่ฝ็จๅพไธใ
+
+ ่ฟๅฐฑๆฏ้ตๅพชๆ ๅ็ๅฅฝๅคโฆโฆ
## ๅฎ้
ๆๆ
-ๆๅผไบคไบๅผๆๆกฃ๏ผhttp://127.0.0.1:8000/docsใ
+ๆๅผ API ๆๆกฃ๏ผhttp://127.0.0.1:8000/docsใ
-### ่บซไปฝ่ฎค่ฏ
+### ่บซไปฝ้ช่ฏ
-็นๅปใAuthorizeใๆ้ฎใ
+็นๅป**Authorize**ๆ้ฎใ
ไฝฟ็จไปฅไธๅญ่ฏ๏ผ
@@ -216,15 +224,15 @@ UserInDB(
-ๅจ็ณป็ปไธญ่ฟ่ก่บซไปฝ่ฎค่ฏๅ๏ผไฝ ๅฐ็ๅฐ๏ผ
+้่ฟ่บซไปฝ้ช่ฏๅ๏ผๆพ็คบไธๅพๆ็คบ็ๅ
ๅฎน๏ผ
-### ่ทๅๆฌไบบ็็จๆทๆฐๆฎ
+### ่ทๅๅฝๅ็จๆทๆฐๆฎ
-็ฐๅจๆง่ก `/users/me` ่ทฏๅพ็ `GET` ๆไฝใ
+ไฝฟ็จ `/users/me` ่ทฏๅพ็ `GET` ๆไฝใ
-ไฝ ๅฐ่ทๅพไฝ ็็จๆทๆฐๆฎ๏ผๅฆ๏ผ
+ๅฏไปฅๆๅๅฆไธๅฝๅ็จๆทๆฐๆฎ๏ผ
```JSON
{
@@ -238,7 +246,7 @@ UserInDB(
-ๅฆๆไฝ ็นๅป้ๅฎๅพๆ ๅนถๆณจ้๏ผ็ถๅๅๆฌกๅฐ่ฏๅไธๆไฝ๏ผๅไผๅพๅฐ HTTP 401 ้่ฏฏ๏ผ
+็นๅปๅฐ้ๅพๆ ๏ผๆณจ้ๅ๏ผๅๆง่กๅๆ ท็ๆไฝ๏ผๅไผๅพๅฐ HTTP 401 ้่ฏฏ๏ผ
```JSON
{
@@ -246,17 +254,17 @@ UserInDB(
}
```
-### ๆชๅฏ็จ็็จๆท
+### ๆชๆฟๆดป็จๆท
-็ฐๅจๅฐ่ฏไฝฟ็จๆชๅฏ็จ็็จๆท๏ผๅนถ้่ฟไปฅไธๆนๅผ่ฟ่ก่บซไปฝ่ฎค่ฏ๏ผ
+ๆต่ฏๆชๆฟๆดป็จๆท๏ผ่พๅ
ฅไปฅไธไฟกๆฏ๏ผ่ฟ่ก่บซไปฝ้ช่ฏ๏ผ
็จๆทๅ๏ผ`alice`
ๅฏ็ ๏ผ`secret2`
-็ถๅๅฐ่ฏๆง่ก `/users/me` ่ทฏๅพ็ `GET` ๆไฝใ
+็ถๅ๏ผๆง่ก `/users/me` ่ทฏๅพ็ `GET` ๆไฝใ
-ไฝ ๅฐๅพๅฐไธไธชใๆชๅฏ็จ็็จๆทใ้่ฏฏ๏ผๅฆ๏ผ
+ๆพ็คบไธๅ**ๆชๆฟๆดป็จๆท**้่ฏฏไฟกๆฏ๏ผ
```JSON
{
@@ -264,12 +272,12 @@ UserInDB(
}
```
-## ๆป็ป
+## ๅฐ็ป
-็ฐๅจไฝ ๆๆกไบไธบไฝ ็ API ๅฎ็ฐไธไธชๅบไบ `username` ๅ `password` ็ๅฎๆดๅฎๅ
จ็ณป็ป็ๅทฅๅ
ทใ
+ไฝฟ็จๆฌ็ซ ็ๅทฅๅ
ทๅฎ็ฐๅบไบ `username` ๅ `password` ็ๅฎๆด API ๅฎๅ
จ็ณป็ปใ
-ไฝฟ็จ่ฟไบๅทฅๅ
ท๏ผไฝ ๅฏไปฅไฝฟๅฎๅ
จ็ณป็ปไธไปปไฝๆฐๆฎๅบไปฅๅไปปไฝ็จๆทๆๆฐๆฎๆจกๅๅ
ผๅฎนใ
+่ฟไบๅทฅๅ
ท่ฎฉๅฎๅ
จ็ณป็ปๅ
ผๅฎนไปปไฝๆฐๆฎๅบใ็จๆทๅๆฐๆฎๆจกๅใ
-ๅฏไธ็ผบๅฐ็็ป่ๆฏๅฎๅฎ้
ไธ่ฟๅนถไธใๅฎๅ
จใใ
+ๅฏไธๆฌ ็ผบ็ๆฏ๏ผๅฎไป็ถไธๆฏ็็**ๅฎๅ
จ**ใ
-ๅจไธไธ็ซ ไธญ๏ผไฝ ๅฐ็ๅฐๅฆไฝไฝฟ็จไธไธชๅฎๅ
จ็ๅๅธๅฏ็ ๅบๅ JWT ไปค็ใ
+ไธไธ็ซ ๏ผไป็ปไฝฟ็จๅฏ็ ๅๅธๆฏๆๅบไธ JWT ไปค็ๅฎ็ฐ็ๆญฃ็ๅฎๅ
จๆบๅถใ
diff --git a/docs/zh/docs/tutorial/sql-databases.md b/docs/zh/docs/tutorial/sql-databases.md
index 482588f94..8b09dc677 100644
--- a/docs/zh/docs/tutorial/sql-databases.md
+++ b/docs/zh/docs/tutorial/sql-databases.md
@@ -258,7 +258,7 @@ connect_args={"check_same_thread": False}
{!> ../../../docs_src/sql_databases/sql_app_py39/schemas.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="3 6-8 11-12 23-24 27-28"
{!> ../../../docs_src/sql_databases/sql_app/schemas.py!}
@@ -302,7 +302,7 @@ name: str
{!> ../../../docs_src/sql_databases/sql_app_py39/schemas.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="15-17 31-34"
{!> ../../../docs_src/sql_databases/sql_app/schemas.py!}
@@ -331,7 +331,7 @@ name: str
{!> ../../../docs_src/sql_databases/sql_app_py39/schemas.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="15 19-20 31 36-37"
{!> ../../../docs_src/sql_databases/sql_app/schemas.py!}
@@ -471,7 +471,7 @@ current_user.items
{!> ../../../docs_src/sql_databases/sql_app_py39/main.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="9"
{!> ../../../docs_src/sql_databases/sql_app/main.py!}
@@ -505,7 +505,7 @@ current_user.items
{!> ../../../docs_src/sql_databases/sql_app_py39/main.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="15-20"
{!> ../../../docs_src/sql_databases/sql_app/main.py!}
@@ -530,7 +530,7 @@ current_user.items
{!> ../../../docs_src/sql_databases/sql_app_py39/main.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="24 32 38 47 53"
{!> ../../../docs_src/sql_databases/sql_app/main.py!}
@@ -551,7 +551,7 @@ current_user.items
{!> ../../../docs_src/sql_databases/sql_app_py39/main.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="23-28 31-34 37-42 45-49 52-55"
{!> ../../../docs_src/sql_databases/sql_app/main.py!}
@@ -650,7 +650,7 @@ def read_user(user_id: int, db: Session = Depends(get_db)):
{!> ../../../docs_src/sql_databases/sql_app_py39/schemas.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python
{!> ../../../docs_src/sql_databases/sql_app/schemas.py!}
@@ -670,7 +670,7 @@ def read_user(user_id: int, db: Session = Depends(get_db)):
{!> ../../../docs_src/sql_databases/sql_app_py39/main.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python
{!> ../../../docs_src/sql_databases/sql_app/main.py!}
@@ -729,7 +729,7 @@ $ uvicorn sql_app.main:app --reload
{!> ../../../docs_src/sql_databases/sql_app_py39/alt_main.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python hl_lines="14-22"
{!> ../../../docs_src/sql_databases/sql_app/alt_main.py!}
diff --git a/docs/zh/docs/tutorial/testing.md b/docs/zh/docs/tutorial/testing.md
index 41f01f8d8..77fff7596 100644
--- a/docs/zh/docs/tutorial/testing.md
+++ b/docs/zh/docs/tutorial/testing.md
@@ -122,7 +122,7 @@
{!> ../../../docs_src/app_testing/app_b_an_py39/main.py!}
```
-=== "Python 3.6+"
+=== "Python 3.8+"
```Python
{!> ../../../docs_src/app_testing/app_b_an/main.py!}
@@ -137,7 +137,7 @@
{!> ../../../docs_src/app_testing/app_b_py310/main.py!}
```
-=== "Python 3.6+ non-Annotated"
+=== "Python 3.8+ non-Annotated"
!!! tip
Prefer to use the `Annotated` version if possible.
diff --git a/docs_src/extending_openapi/tutorial003.py b/docs_src/configure_swagger_ui/tutorial001.py
similarity index 100%
rename from docs_src/extending_openapi/tutorial003.py
rename to docs_src/configure_swagger_ui/tutorial001.py
diff --git a/docs_src/extending_openapi/tutorial004.py b/docs_src/configure_swagger_ui/tutorial002.py
similarity index 100%
rename from docs_src/extending_openapi/tutorial004.py
rename to docs_src/configure_swagger_ui/tutorial002.py
diff --git a/docs_src/extending_openapi/tutorial005.py b/docs_src/configure_swagger_ui/tutorial003.py
similarity index 100%
rename from docs_src/extending_openapi/tutorial005.py
rename to docs_src/configure_swagger_ui/tutorial003.py
diff --git a/docs_src/custom_docs_ui/tutorial001.py b/docs_src/custom_docs_ui/tutorial001.py
new file mode 100644
index 000000000..f7ceb0c2f
--- /dev/null
+++ b/docs_src/custom_docs_ui/tutorial001.py
@@ -0,0 +1,38 @@
+from fastapi import FastAPI
+from fastapi.openapi.docs import (
+ get_redoc_html,
+ get_swagger_ui_html,
+ get_swagger_ui_oauth2_redirect_html,
+)
+
+app = FastAPI(docs_url=None, redoc_url=None)
+
+
+@app.get("/docs", include_in_schema=False)
+async def custom_swagger_ui_html():
+ return get_swagger_ui_html(
+ openapi_url=app.openapi_url,
+ title=app.title + " - Swagger UI",
+ oauth2_redirect_url=app.swagger_ui_oauth2_redirect_url,
+ swagger_js_url="https://unpkg.com/swagger-ui-dist@5/swagger-ui-bundle.js",
+ swagger_css_url="https://unpkg.com/swagger-ui-dist@5/swagger-ui.css",
+ )
+
+
+@app.get(app.swagger_ui_oauth2_redirect_url, include_in_schema=False)
+async def swagger_ui_redirect():
+ return get_swagger_ui_oauth2_redirect_html()
+
+
+@app.get("/redoc", include_in_schema=False)
+async def redoc_html():
+ return get_redoc_html(
+ openapi_url=app.openapi_url,
+ title=app.title + " - ReDoc",
+ redoc_js_url="https://unpkg.com/redoc@next/bundles/redoc.standalone.js",
+ )
+
+
+@app.get("/users/{username}")
+async def read_user(username: str):
+ return {"message": f"Hello {username}"}
diff --git a/docs_src/extending_openapi/tutorial002.py b/docs_src/custom_docs_ui/tutorial002.py
similarity index 100%
rename from docs_src/extending_openapi/tutorial002.py
rename to docs_src/custom_docs_ui/tutorial002.py
diff --git a/docs_src/openapi_webhooks/tutorial001.py b/docs_src/openapi_webhooks/tutorial001.py
index 5016f5b00..55822bb48 100644
--- a/docs_src/openapi_webhooks/tutorial001.py
+++ b/docs_src/openapi_webhooks/tutorial001.py
@@ -8,7 +8,7 @@ app = FastAPI()
class Subscription(BaseModel):
username: str
- montly_fee: float
+ monthly_fee: float
start_date: datetime
diff --git a/docs_src/python_types/tutorial011.py b/docs_src/python_types/tutorial011.py
index c8634cbff..297a84db6 100644
--- a/docs_src/python_types/tutorial011.py
+++ b/docs_src/python_types/tutorial011.py
@@ -6,7 +6,7 @@ from pydantic import BaseModel
class User(BaseModel):
id: int
- name = "John Doe"
+ name: str = "John Doe"
signup_ts: Union[datetime, None] = None
friends: List[int] = []
diff --git a/docs_src/python_types/tutorial011_py310.py b/docs_src/python_types/tutorial011_py310.py
index 7f173880f..842760c60 100644
--- a/docs_src/python_types/tutorial011_py310.py
+++ b/docs_src/python_types/tutorial011_py310.py
@@ -5,7 +5,7 @@ from pydantic import BaseModel
class User(BaseModel):
id: int
- name = "John Doe"
+ name: str = "John Doe"
signup_ts: datetime | None = None
friends: list[int] = []
diff --git a/docs_src/python_types/tutorial011_py39.py b/docs_src/python_types/tutorial011_py39.py
index 468496f51..4eb40b405 100644
--- a/docs_src/python_types/tutorial011_py39.py
+++ b/docs_src/python_types/tutorial011_py39.py
@@ -6,7 +6,7 @@ from pydantic import BaseModel
class User(BaseModel):
id: int
- name = "John Doe"
+ name: str = "John Doe"
signup_ts: Union[datetime, None] = None
friends: list[int] = []
diff --git a/docs_src/schema_extra_example/tutorial005.py b/docs_src/schema_extra_example/tutorial005.py
new file mode 100644
index 000000000..b8217c27e
--- /dev/null
+++ b/docs_src/schema_extra_example/tutorial005.py
@@ -0,0 +1,51 @@
+from typing import Union
+
+from fastapi import Body, FastAPI
+from pydantic import BaseModel
+
+app = FastAPI()
+
+
+class Item(BaseModel):
+ name: str
+ description: Union[str, None] = None
+ price: float
+ tax: Union[float, None] = None
+
+
+@app.put("/items/{item_id}")
+async def update_item(
+ *,
+ item_id: int,
+ item: Item = Body(
+ openapi_examples={
+ "normal": {
+ "summary": "A normal example",
+ "description": "A **normal** item works correctly.",
+ "value": {
+ "name": "Foo",
+ "description": "A very nice Item",
+ "price": 35.4,
+ "tax": 3.2,
+ },
+ },
+ "converted": {
+ "summary": "An example with converted data",
+ "description": "FastAPI can convert price `strings` to actual `numbers` automatically",
+ "value": {
+ "name": "Bar",
+ "price": "35.4",
+ },
+ },
+ "invalid": {
+ "summary": "Invalid data is rejected with an error",
+ "value": {
+ "name": "Baz",
+ "price": "thirty five point four",
+ },
+ },
+ },
+ ),
+):
+ results = {"item_id": item_id, "item": item}
+ return results
diff --git a/docs_src/schema_extra_example/tutorial005_an.py b/docs_src/schema_extra_example/tutorial005_an.py
new file mode 100644
index 000000000..4b2d9c662
--- /dev/null
+++ b/docs_src/schema_extra_example/tutorial005_an.py
@@ -0,0 +1,55 @@
+from typing import Union
+
+from fastapi import Body, FastAPI
+from pydantic import BaseModel
+from typing_extensions import Annotated
+
+app = FastAPI()
+
+
+class Item(BaseModel):
+ name: str
+ description: Union[str, None] = None
+ price: float
+ tax: Union[float, None] = None
+
+
+@app.put("/items/{item_id}")
+async def update_item(
+ *,
+ item_id: int,
+ item: Annotated[
+ Item,
+ Body(
+ openapi_examples={
+ "normal": {
+ "summary": "A normal example",
+ "description": "A **normal** item works correctly.",
+ "value": {
+ "name": "Foo",
+ "description": "A very nice Item",
+ "price": 35.4,
+ "tax": 3.2,
+ },
+ },
+ "converted": {
+ "summary": "An example with converted data",
+ "description": "FastAPI can convert price `strings` to actual `numbers` automatically",
+ "value": {
+ "name": "Bar",
+ "price": "35.4",
+ },
+ },
+ "invalid": {
+ "summary": "Invalid data is rejected with an error",
+ "value": {
+ "name": "Baz",
+ "price": "thirty five point four",
+ },
+ },
+ },
+ ),
+ ],
+):
+ results = {"item_id": item_id, "item": item}
+ return results
diff --git a/docs_src/schema_extra_example/tutorial005_an_py310.py b/docs_src/schema_extra_example/tutorial005_an_py310.py
new file mode 100644
index 000000000..64dc2cf90
--- /dev/null
+++ b/docs_src/schema_extra_example/tutorial005_an_py310.py
@@ -0,0 +1,54 @@
+from typing import Annotated
+
+from fastapi import Body, FastAPI
+from pydantic import BaseModel
+
+app = FastAPI()
+
+
+class Item(BaseModel):
+ name: str
+ description: str | None = None
+ price: float
+ tax: float | None = None
+
+
+@app.put("/items/{item_id}")
+async def update_item(
+ *,
+ item_id: int,
+ item: Annotated[
+ Item,
+ Body(
+ openapi_examples={
+ "normal": {
+ "summary": "A normal example",
+ "description": "A **normal** item works correctly.",
+ "value": {
+ "name": "Foo",
+ "description": "A very nice Item",
+ "price": 35.4,
+ "tax": 3.2,
+ },
+ },
+ "converted": {
+ "summary": "An example with converted data",
+ "description": "FastAPI can convert price `strings` to actual `numbers` automatically",
+ "value": {
+ "name": "Bar",
+ "price": "35.4",
+ },
+ },
+ "invalid": {
+ "summary": "Invalid data is rejected with an error",
+ "value": {
+ "name": "Baz",
+ "price": "thirty five point four",
+ },
+ },
+ },
+ ),
+ ],
+):
+ results = {"item_id": item_id, "item": item}
+ return results
diff --git a/docs_src/schema_extra_example/tutorial005_an_py39.py b/docs_src/schema_extra_example/tutorial005_an_py39.py
new file mode 100644
index 000000000..edeb1affc
--- /dev/null
+++ b/docs_src/schema_extra_example/tutorial005_an_py39.py
@@ -0,0 +1,54 @@
+from typing import Annotated, Union
+
+from fastapi import Body, FastAPI
+from pydantic import BaseModel
+
+app = FastAPI()
+
+
+class Item(BaseModel):
+ name: str
+ description: Union[str, None] = None
+ price: float
+ tax: Union[float, None] = None
+
+
+@app.put("/items/{item_id}")
+async def update_item(
+ *,
+ item_id: int,
+ item: Annotated[
+ Item,
+ Body(
+ openapi_examples={
+ "normal": {
+ "summary": "A normal example",
+ "description": "A **normal** item works correctly.",
+ "value": {
+ "name": "Foo",
+ "description": "A very nice Item",
+ "price": 35.4,
+ "tax": 3.2,
+ },
+ },
+ "converted": {
+ "summary": "An example with converted data",
+ "description": "FastAPI can convert price `strings` to actual `numbers` automatically",
+ "value": {
+ "name": "Bar",
+ "price": "35.4",
+ },
+ },
+ "invalid": {
+ "summary": "Invalid data is rejected with an error",
+ "value": {
+ "name": "Baz",
+ "price": "thirty five point four",
+ },
+ },
+ },
+ ),
+ ],
+):
+ results = {"item_id": item_id, "item": item}
+ return results
diff --git a/docs_src/schema_extra_example/tutorial005_py310.py b/docs_src/schema_extra_example/tutorial005_py310.py
new file mode 100644
index 000000000..eef973343
--- /dev/null
+++ b/docs_src/schema_extra_example/tutorial005_py310.py
@@ -0,0 +1,49 @@
+from fastapi import Body, FastAPI
+from pydantic import BaseModel
+
+app = FastAPI()
+
+
+class Item(BaseModel):
+ name: str
+ description: str | None = None
+ price: float
+ tax: float | None = None
+
+
+@app.put("/items/{item_id}")
+async def update_item(
+ *,
+ item_id: int,
+ item: Item = Body(
+ openapi_examples={
+ "normal": {
+ "summary": "A normal example",
+ "description": "A **normal** item works correctly.",
+ "value": {
+ "name": "Foo",
+ "description": "A very nice Item",
+ "price": 35.4,
+ "tax": 3.2,
+ },
+ },
+ "converted": {
+ "summary": "An example with converted data",
+ "description": "FastAPI can convert price `strings` to actual `numbers` automatically",
+ "value": {
+ "name": "Bar",
+ "price": "35.4",
+ },
+ },
+ "invalid": {
+ "summary": "Invalid data is rejected with an error",
+ "value": {
+ "name": "Baz",
+ "price": "thirty five point four",
+ },
+ },
+ },
+ ),
+):
+ results = {"item_id": item_id, "item": item}
+ return results
diff --git a/docs_src/separate_openapi_schemas/tutorial001.py b/docs_src/separate_openapi_schemas/tutorial001.py
new file mode 100644
index 000000000..415eef8e2
--- /dev/null
+++ b/docs_src/separate_openapi_schemas/tutorial001.py
@@ -0,0 +1,28 @@
+from typing import List, Union
+
+from fastapi import FastAPI
+from pydantic import BaseModel
+
+
+class Item(BaseModel):
+ name: str
+ description: Union[str, None] = None
+
+
+app = FastAPI()
+
+
+@app.post("/items/")
+def create_item(item: Item):
+ return item
+
+
+@app.get("/items/")
+def read_items() -> List[Item]:
+ return [
+ Item(
+ name="Portal Gun",
+ description="Device to travel through the multi-rick-verse",
+ ),
+ Item(name="Plumbus"),
+ ]
diff --git a/docs_src/separate_openapi_schemas/tutorial001_py310.py b/docs_src/separate_openapi_schemas/tutorial001_py310.py
new file mode 100644
index 000000000..289cb54ed
--- /dev/null
+++ b/docs_src/separate_openapi_schemas/tutorial001_py310.py
@@ -0,0 +1,26 @@
+from fastapi import FastAPI
+from pydantic import BaseModel
+
+
+class Item(BaseModel):
+ name: str
+ description: str | None = None
+
+
+app = FastAPI()
+
+
+@app.post("/items/")
+def create_item(item: Item):
+ return item
+
+
+@app.get("/items/")
+def read_items() -> list[Item]:
+ return [
+ Item(
+ name="Portal Gun",
+ description="Device to travel through the multi-rick-verse",
+ ),
+ Item(name="Plumbus"),
+ ]
diff --git a/docs_src/separate_openapi_schemas/tutorial001_py39.py b/docs_src/separate_openapi_schemas/tutorial001_py39.py
new file mode 100644
index 000000000..63cffd1e3
--- /dev/null
+++ b/docs_src/separate_openapi_schemas/tutorial001_py39.py
@@ -0,0 +1,28 @@
+from typing import Optional
+
+from fastapi import FastAPI
+from pydantic import BaseModel
+
+
+class Item(BaseModel):
+ name: str
+ description: Optional[str] = None
+
+
+app = FastAPI()
+
+
+@app.post("/items/")
+def create_item(item: Item):
+ return item
+
+
+@app.get("/items/")
+def read_items() -> list[Item]:
+ return [
+ Item(
+ name="Portal Gun",
+ description="Device to travel through the multi-rick-verse",
+ ),
+ Item(name="Plumbus"),
+ ]
diff --git a/docs_src/separate_openapi_schemas/tutorial002.py b/docs_src/separate_openapi_schemas/tutorial002.py
new file mode 100644
index 000000000..7df93783b
--- /dev/null
+++ b/docs_src/separate_openapi_schemas/tutorial002.py
@@ -0,0 +1,28 @@
+from typing import List, Union
+
+from fastapi import FastAPI
+from pydantic import BaseModel
+
+
+class Item(BaseModel):
+ name: str
+ description: Union[str, None] = None
+
+
+app = FastAPI(separate_input_output_schemas=False)
+
+
+@app.post("/items/")
+def create_item(item: Item):
+ return item
+
+
+@app.get("/items/")
+def read_items() -> List[Item]:
+ return [
+ Item(
+ name="Portal Gun",
+ description="Device to travel through the multi-rick-verse",
+ ),
+ Item(name="Plumbus"),
+ ]
diff --git a/docs_src/separate_openapi_schemas/tutorial002_py310.py b/docs_src/separate_openapi_schemas/tutorial002_py310.py
new file mode 100644
index 000000000..5db210872
--- /dev/null
+++ b/docs_src/separate_openapi_schemas/tutorial002_py310.py
@@ -0,0 +1,26 @@
+from fastapi import FastAPI
+from pydantic import BaseModel
+
+
+class Item(BaseModel):
+ name: str
+ description: str | None = None
+
+
+app = FastAPI(separate_input_output_schemas=False)
+
+
+@app.post("/items/")
+def create_item(item: Item):
+ return item
+
+
+@app.get("/items/")
+def read_items() -> list[Item]:
+ return [
+ Item(
+ name="Portal Gun",
+ description="Device to travel through the multi-rick-verse",
+ ),
+ Item(name="Plumbus"),
+ ]
diff --git a/docs_src/separate_openapi_schemas/tutorial002_py39.py b/docs_src/separate_openapi_schemas/tutorial002_py39.py
new file mode 100644
index 000000000..50d997d92
--- /dev/null
+++ b/docs_src/separate_openapi_schemas/tutorial002_py39.py
@@ -0,0 +1,28 @@
+from typing import Optional
+
+from fastapi import FastAPI
+from pydantic import BaseModel
+
+
+class Item(BaseModel):
+ name: str
+ description: Optional[str] = None
+
+
+app = FastAPI(separate_input_output_schemas=False)
+
+
+@app.post("/items/")
+def create_item(item: Item):
+ return item
+
+
+@app.get("/items/")
+def read_items() -> list[Item]:
+ return [
+ Item(
+ name="Portal Gun",
+ description="Device to travel through the multi-rick-verse",
+ ),
+ Item(name="Plumbus"),
+ ]
diff --git a/fastapi/__init__.py b/fastapi/__init__.py
index c113ac1fd..4fdb155c2 100644
--- a/fastapi/__init__.py
+++ b/fastapi/__init__.py
@@ -1,6 +1,6 @@
"""FastAPI framework, high performance, easy to learn, fast to code, ready for production"""
-__version__ = "0.101.0"
+__version__ = "0.104.0"
from starlette import status as status
diff --git a/fastapi/_compat.py b/fastapi/_compat.py
index 9ffcaf409..a4b305d42 100644
--- a/fastapi/_compat.py
+++ b/fastapi/_compat.py
@@ -58,9 +58,15 @@ if PYDANTIC_V2:
from pydantic_core import CoreSchema as CoreSchema
from pydantic_core import PydanticUndefined, PydanticUndefinedType
from pydantic_core import Url as Url
- from pydantic_core.core_schema import (
- general_plain_validator_function as general_plain_validator_function,
- )
+
+ try:
+ from pydantic_core.core_schema import (
+ with_info_plain_validator_function as with_info_plain_validator_function,
+ )
+ except ImportError: # pragma: no cover
+ from pydantic_core.core_schema import (
+ general_plain_validator_function as with_info_plain_validator_function, # noqa: F401
+ )
Required = PydanticUndefined
Undefined = PydanticUndefined
@@ -181,9 +187,13 @@ if PYDANTIC_V2:
field_mapping: Dict[
Tuple[ModelField, Literal["validation", "serialization"]], JsonSchemaValue
],
+ separate_input_output_schemas: bool = True,
) -> Dict[str, Any]:
+ override_mode: Union[Literal["validation"], None] = (
+ None if separate_input_output_schemas else "validation"
+ )
# This expects that GenerateJsonSchema was already used to generate the definitions
- json_schema = field_mapping[(field, field.mode)]
+ json_schema = field_mapping[(field, override_mode or field.mode)]
if "$ref" not in json_schema:
# TODO remove when deprecating Pydantic v1
# Ref: https://github.com/pydantic/pydantic/blob/d61792cc42c80b13b23e3ffa74bc37ec7c77f7d1/pydantic/schema.py#L207
@@ -200,14 +210,19 @@ if PYDANTIC_V2:
fields: List[ModelField],
schema_generator: GenerateJsonSchema,
model_name_map: ModelNameMap,
+ separate_input_output_schemas: bool = True,
) -> Tuple[
Dict[
Tuple[ModelField, Literal["validation", "serialization"]], JsonSchemaValue
],
Dict[str, Dict[str, Any]],
]:
+ override_mode: Union[Literal["validation"], None] = (
+ None if separate_input_output_schemas else "validation"
+ )
inputs = [
- (field, field.mode, field._type_adapter.core_schema) for field in fields
+ (field, override_mode or field.mode, field._type_adapter.core_schema)
+ for field in fields
]
field_mapping, definitions = schema_generator.generate_definitions(
inputs=inputs
@@ -336,7 +351,7 @@ else:
class PydanticSchemaGenerationError(Exception): # type: ignore[no-redef]
pass
- def general_plain_validator_function( # type: ignore[misc]
+ def with_info_plain_validator_function( # type: ignore[misc]
function: Callable[..., Any],
*,
ref: Union[str, None] = None,
@@ -429,6 +444,7 @@ else:
field_mapping: Dict[
Tuple[ModelField, Literal["validation", "serialization"]], JsonSchemaValue
],
+ separate_input_output_schemas: bool = True,
) -> Dict[str, Any]:
# This expects that GenerateJsonSchema was already used to generate the definitions
return field_schema( # type: ignore[no-any-return]
@@ -444,6 +460,7 @@ else:
fields: List[ModelField],
schema_generator: GenerateJsonSchema,
model_name_map: ModelNameMap,
+ separate_input_output_schemas: bool = True,
) -> Tuple[
Dict[
Tuple[ModelField, Literal["validation", "serialization"]], JsonSchemaValue
diff --git a/fastapi/applications.py b/fastapi/applications.py
index e32cfa03d..8ca374a54 100644
--- a/fastapi/applications.py
+++ b/fastapi/applications.py
@@ -43,56 +43,785 @@ from starlette.requests import Request
from starlette.responses import HTMLResponse, JSONResponse, Response
from starlette.routing import BaseRoute
from starlette.types import ASGIApp, Lifespan, Receive, Scope, Send
+from typing_extensions import Annotated, Doc, deprecated # type: ignore [attr-defined]
AppType = TypeVar("AppType", bound="FastAPI")
class FastAPI(Starlette):
+ """
+ `FastAPI` app class, the main entrypoint to use FastAPI.
+
+ Read more in the
+ [FastAPI docs for First Steps](https://fastapi.tiangolo.com/tutorial/first-steps/).
+
+ ## Example
+
+ ```python
+ from fastapi import FastAPI
+
+ app = FastAPI()
+ ```
+ """
+
def __init__(
self: AppType,
*,
- debug: bool = False,
- routes: Optional[List[BaseRoute]] = None,
- title: str = "FastAPI",
- summary: Optional[str] = None,
- description: str = "",
- version: str = "0.1.0",
- openapi_url: Optional[str] = "/openapi.json",
- openapi_tags: Optional[List[Dict[str, Any]]] = None,
- servers: Optional[List[Dict[str, Union[str, Any]]]] = None,
- dependencies: Optional[Sequence[Depends]] = None,
- default_response_class: Type[Response] = Default(JSONResponse),
- redirect_slashes: bool = True,
- docs_url: Optional[str] = "/docs",
- redoc_url: Optional[str] = "/redoc",
- swagger_ui_oauth2_redirect_url: Optional[str] = "/docs/oauth2-redirect",
- swagger_ui_init_oauth: Optional[Dict[str, Any]] = None,
- middleware: Optional[Sequence[Middleware]] = None,
- exception_handlers: Optional[
- Dict[
- Union[int, Type[Exception]],
- Callable[[Request, Any], Coroutine[Any, Any, Response]],
- ]
+ debug: Annotated[
+ bool,
+ Doc(
+ """
+ Boolean indicating if debug tracebacks should be returned on server
+ errors.
+
+ Read more in the
+ [Starlette docs for Applications](https://www.starlette.io/applications/#instantiating-the-application).
+ """
+ ),
+ ] = False,
+ routes: Annotated[
+ Optional[List[BaseRoute]],
+ Doc(
+ """
+ **Note**: you probably shouldn't use this parameter, it is inherited
+ from Starlette and supported for compatibility.
+
+ ---
+
+ A list of routes to serve incoming HTTP and WebSocket requests.
+ """
+ ),
+ deprecated(
+ """
+ You normally wouldn't use this parameter with FastAPI, it is inherited
+ from Starlette and supported for compatibility.
+
+ In FastAPI, you normally would use the *path operation methods*,
+ like `app.get()`, `app.post()`, etc.
+ """
+ ),
] = None,
- on_startup: Optional[Sequence[Callable[[], Any]]] = None,
- on_shutdown: Optional[Sequence[Callable[[], Any]]] = None,
- lifespan: Optional[Lifespan[AppType]] = None,
- terms_of_service: Optional[str] = None,
- contact: Optional[Dict[str, Union[str, Any]]] = None,
- license_info: Optional[Dict[str, Union[str, Any]]] = None,
- openapi_prefix: str = "",
- root_path: str = "",
- root_path_in_servers: bool = True,
- responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,
- callbacks: Optional[List[BaseRoute]] = None,
- webhooks: Optional[routing.APIRouter] = None,
- deprecated: Optional[bool] = None,
- include_in_schema: bool = True,
- swagger_ui_parameters: Optional[Dict[str, Any]] = None,
- generate_unique_id_function: Callable[[routing.APIRoute], str] = Default(
- generate_unique_id
- ),
- **extra: Any,
+ title: Annotated[
+ str,
+ Doc(
+ """
+ The title of the API.
+
+ It will be added to the generated OpenAPI (e.g. visible at `/docs`).
+
+ Read more in the
+ [FastAPI docs for Metadata and Docs URLs](https://fastapi.tiangolo.com/tutorial/metadata/#metadata-for-api).
+
+ **Example**
+
+ ```python
+ from fastapi import FastAPI
+
+ app = FastAPI(title="ChimichangApp")
+ ```
+ """
+ ),
+ ] = "FastAPI",
+ summary: Annotated[
+ Optional[str],
+ Doc(
+ """
+ A short summary of the API.
+
+ It will be added to the generated OpenAPI (e.g. visible at `/docs`).
+
+ Read more in the
+ [FastAPI docs for Metadata and Docs URLs](https://fastapi.tiangolo.com/tutorial/metadata/#metadata-for-api).
+
+ **Example**
+
+ ```python
+ from fastapi import FastAPI
+
+ app = FastAPI(summary="Deadpond's favorite app. Nuff said.")
+ ```
+ """
+ ),
+ ] = None,
+ description: Annotated[
+ str,
+ Doc(
+ '''
+ A description of the API. Supports Markdown (using
+ [CommonMark syntax](https://commonmark.org/)).
+
+ It will be added to the generated OpenAPI (e.g. visible at `/docs`).
+
+ Read more in the
+ [FastAPI docs for Metadata and Docs URLs](https://fastapi.tiangolo.com/tutorial/metadata/#metadata-for-api).
+
+ **Example**
+
+ ```python
+ from fastapi import FastAPI
+
+ app = FastAPI(
+ description="""
+ ChimichangApp API helps you do awesome stuff. ๐
+
+ ## Items
+
+ You can **read items**.
+
+ ## Users
+
+ You will be able to:
+
+ * **Create users** (_not implemented_).
+ * **Read users** (_not implemented_).
+
+ """
+ )
+ ```
+ '''
+ ),
+ ] = "",
+ version: Annotated[
+ str,
+ Doc(
+ """
+ The version of the API.
+
+ **Note** This is the version of your application, not the version of
+ the OpenAPI specification nor the version of FastAPI being used.
+
+ It will be added to the generated OpenAPI (e.g. visible at `/docs`).
+
+ Read more in the
+ [FastAPI docs for Metadata and Docs URLs](https://fastapi.tiangolo.com/tutorial/metadata/#metadata-for-api).
+
+ **Example**
+
+ ```python
+ from fastapi import FastAPI
+
+ app = FastAPI(version="0.0.1")
+ ```
+ """
+ ),
+ ] = "0.1.0",
+ openapi_url: Annotated[
+ Optional[str],
+ Doc(
+ """
+ The URL where the OpenAPI schema will be served from.
+
+ If you set it to `None`, no OpenAPI schema will be served publicly, and
+ the default automatic endpoints `/docs` and `/redoc` will also be
+ disabled.
+
+ Read more in the
+ [FastAPI docs for Metadata and Docs URLs](https://fastapi.tiangolo.com/tutorial/metadata/#openapi-url).
+
+ **Example**
+
+ ```python
+ from fastapi import FastAPI
+
+ app = FastAPI(openapi_url="/api/v1/openapi.json")
+ ```
+ """
+ ),
+ ] = "/openapi.json",
+ openapi_tags: Annotated[
+ Optional[List[Dict[str, Any]]],
+ Doc(
+ """
+ A list of tags used by OpenAPI, these are the same `tags` you can set
+ in the *path operations*, like:
+
+ * `@app.get("/users/", tags=["users"])`
+ * `@app.get("/items/", tags=["items"])`
+
+ The order of the tags can be used to specify the order shown in
+ tools like Swagger UI, used in the automatic path `/docs`.
+
+ It's not required to specify all the tags used.
+
+ The tags that are not declared MAY be organized randomly or based
+ on the tools' logic. Each tag name in the list MUST be unique.
+
+ The value of each item is a `dict` containing:
+
+ * `name`: The name of the tag.
+ * `description`: A short description of the tag.
+ [CommonMark syntax](https://commonmark.org/) MAY be used for rich
+ text representation.
+ * `externalDocs`: Additional external documentation for this tag. If
+ provided, it would contain a `dict` with:
+ * `description`: A short description of the target documentation.
+ [CommonMark syntax](https://commonmark.org/) MAY be used for
+ rich text representation.
+ * `url`: The URL for the target documentation. Value MUST be in
+ the form of a URL.
+
+ Read more in the
+ [FastAPI docs for Metadata and Docs URLs](https://fastapi.tiangolo.com/tutorial/metadata/#metadata-for-tags).
+
+ **Example**
+
+ ```python
+ from fastapi import FastAPI
+
+ tags_metadata = [
+ {
+ "name": "users",
+ "description": "Operations with users. The **login** logic is also here.",
+ },
+ {
+ "name": "items",
+ "description": "Manage items. So _fancy_ they have their own docs.",
+ "externalDocs": {
+ "description": "Items external docs",
+ "url": "https://fastapi.tiangolo.com/",
+ },
+ },
+ ]
+
+ app = FastAPI(openapi_tags=tags_metadata)
+ ```
+ """
+ ),
+ ] = None,
+ servers: Annotated[
+ Optional[List[Dict[str, Union[str, Any]]]],
+ Doc(
+ """
+ A `list` of `dict`s with connectivity information to a target server.
+
+ You would use it, for example, if your application is served from
+ different domains and you want to use the same Swagger UI in the
+ browser to interact with each of them (instead of having multiple
+ browser tabs open). Or if you want to leave fixed the possible URLs.
+
+ If the servers `list` is not provided, or is an empty `list`, the
+ default value would be a a `dict` with a `url` value of `/`.
+
+ Each item in the `list` is a `dict` containing:
+
+ * `url`: A URL to the target host. This URL supports Server Variables
+ and MAY be relative, to indicate that the host location is relative
+ to the location where the OpenAPI document is being served. Variable
+ substitutions will be made when a variable is named in `{`brackets`}`.
+ * `description`: An optional string describing the host designated by
+ the URL. [CommonMark syntax](https://commonmark.org/) MAY be used for
+ rich text representation.
+ * `variables`: A `dict` between a variable name and its value. The value
+ is used for substitution in the server's URL template.
+
+ Read more in the
+ [FastAPI docs for Behind a Proxy](https://fastapi.tiangolo.com/advanced/behind-a-proxy/#additional-servers).
+
+ **Example**
+
+ ```python
+ from fastapi import FastAPI
+
+ app = FastAPI(
+ servers=[
+ {"url": "https://stag.example.com", "description": "Staging environment"},
+ {"url": "https://prod.example.com", "description": "Production environment"},
+ ]
+ )
+ ```
+ """
+ ),
+ ] = None,
+ dependencies: Annotated[
+ Optional[Sequence[Depends]],
+ Doc(
+ """
+ A list of global dependencies, they will be applied to each
+ *path operation*, including in sub-routers.
+
+ Read more about it in the
+ [FastAPI docs for Global Dependencies](https://fastapi.tiangolo.com/tutorial/dependencies/global-dependencies/).
+
+ **Example**
+
+ ```python
+ from fastapi import Depends, FastAPI
+
+ from .dependencies import func_dep_1, func_dep_2
+
+ app = FastAPI(dependencies=[Depends(func_dep_1), Depends(func_dep_2)])
+ ```
+ """
+ ),
+ ] = None,
+ default_response_class: Annotated[
+ Type[Response],
+ Doc(
+ """
+ The default response class to be used.
+
+ Read more in the
+ [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).
+
+ **Example**
+
+ ```python
+ from fastapi import FastAPI
+ from fastapi.responses import ORJSONResponse
+
+ app = FastAPI(default_response_class=ORJSONResponse)
+ ```
+ """
+ ),
+ ] = Default(JSONResponse),
+ redirect_slashes: Annotated[
+ bool,
+ Doc(
+ """
+ Whether to detect and redirect slashes in URLs when the client doesn't
+ use the same format.
+
+ **Example**
+
+ ```python
+ from fastapi import FastAPI
+
+ app = FastAPI(redirect_slashes=True) # the default
+
+ @app.get("/items/")
+ async def read_items():
+ return [{"item_id": "Foo"}]
+ ```
+
+ With this app, if a client goes to `/items` (without a trailing slash),
+ they will be automatically redirected with an HTTP status code of 307
+ to `/items/`.
+ """
+ ),
+ ] = True,
+ docs_url: Annotated[
+ Optional[str],
+ Doc(
+ """
+ The path to the automatic interactive API documentation.
+ It is handled in the browser by Swagger UI.
+
+ The default URL is `/docs`. You can disable it by setting it to `None`.
+
+ If `openapi_url` is set to `None`, this will be automatically disabled.
+
+ Read more in the
+ [FastAPI docs for Metadata and Docs URLs](https://fastapi.tiangolo.com/tutorial/metadata/#docs-urls).
+
+ **Example**
+
+ ```python
+ from fastapi import FastAPI
+
+ app = FastAPI(docs_url="/documentation", redoc_url=None)
+ ```
+ """
+ ),
+ ] = "/docs",
+ redoc_url: Annotated[
+ Optional[str],
+ Doc(
+ """
+ The path to the alternative automatic interactive API documentation
+ provided by ReDoc.
+
+ The default URL is `/redoc`. You can disable it by setting it to `None`.
+
+ If `openapi_url` is set to `None`, this will be automatically disabled.
+
+ Read more in the
+ [FastAPI docs for Metadata and Docs URLs](https://fastapi.tiangolo.com/tutorial/metadata/#docs-urls).
+
+ **Example**
+
+ ```python
+ from fastapi import FastAPI
+
+ app = FastAPI(docs_url="/documentation", redoc_url="redocumentation")
+ ```
+ """
+ ),
+ ] = "/redoc",
+ swagger_ui_oauth2_redirect_url: Annotated[
+ Optional[str],
+ Doc(
+ """
+ The OAuth2 redirect endpoint for the Swagger UI.
+
+ By default it is `/docs/oauth2-redirect`.
+
+ This is only used if you use OAuth2 (with the "Authorize" button)
+ with Swagger UI.
+ """
+ ),
+ ] = "/docs/oauth2-redirect",
+ swagger_ui_init_oauth: Annotated[
+ Optional[Dict[str, Any]],
+ Doc(
+ """
+ OAuth2 configuration for the Swagger UI, by default shown at `/docs`.
+
+ Read more about the available configuration options in the
+ [Swagger UI docs](https://swagger.io/docs/open-source-tools/swagger-ui/usage/oauth2/).
+ """
+ ),
+ ] = None,
+ middleware: Annotated[
+ Optional[Sequence[Middleware]],
+ Doc(
+ """
+ List of middleware to be added when creating the application.
+
+ In FastAPI you would normally do this with `app.add_middleware()`
+ instead.
+
+ Read more in the
+ [FastAPI docs for Middleware](https://fastapi.tiangolo.com/tutorial/middleware/).
+ """
+ ),
+ ] = None,
+ exception_handlers: Annotated[
+ Optional[
+ Dict[
+ Union[int, Type[Exception]],
+ Callable[[Request, Any], Coroutine[Any, Any, Response]],
+ ]
+ ],
+ Doc(
+ """
+ A dictionary with handlers for exceptions.
+
+ In FastAPI, you would normally use the decorator
+ `@app.exception_handler()`.
+
+ Read more in the
+ [FastAPI docs for Handling Errors](https://fastapi.tiangolo.com/tutorial/handling-errors/).
+ """
+ ),
+ ] = None,
+ on_startup: Annotated[
+ Optional[Sequence[Callable[[], Any]]],
+ Doc(
+ """
+ A list of startup event handler functions.
+
+ You should instead use the `lifespan` handlers.
+
+ Read more in the [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).
+ """
+ ),
+ ] = None,
+ on_shutdown: Annotated[
+ Optional[Sequence[Callable[[], Any]]],
+ Doc(
+ """
+ A list of shutdown event handler functions.
+
+ You should instead use the `lifespan` handlers.
+
+ Read more in the
+ [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).
+ """
+ ),
+ ] = None,
+ lifespan: Annotated[
+ Optional[Lifespan[AppType]],
+ Doc(
+ """
+ A `Lifespan` context manager handler. This replaces `startup` and
+ `shutdown` functions with a single context manager.
+
+ Read more in the
+ [FastAPI docs for `lifespan`](https://fastapi.tiangolo.com/advanced/events/).
+ """
+ ),
+ ] = None,
+ terms_of_service: Annotated[
+ Optional[str],
+ Doc(
+ """
+ A URL to the Terms of Service for your API.
+
+ It will be added to the generated OpenAPI (e.g. visible at `/docs`).
+
+ Read more at the
+ [FastAPI docs for Metadata and Docs URLs](https://fastapi.tiangolo.com/tutorial/metadata/#metadata-for-api).
+
+ **Example**
+
+ ```python
+ app = FastAPI(terms_of_service="http://example.com/terms/")
+ ```
+ """
+ ),
+ ] = None,
+ contact: Annotated[
+ Optional[Dict[str, Union[str, Any]]],
+ Doc(
+ """
+ A dictionary with the contact information for the exposed API.
+
+ It can contain several fields.
+
+ * `name`: (`str`) The name of the contact person/organization.
+ * `url`: (`str`) A URL pointing to the contact information. MUST be in
+ the format of a URL.
+ * `email`: (`str`) The email address of the contact person/organization.
+ MUST be in the format of an email address.
+
+ It will be added to the generated OpenAPI (e.g. visible at `/docs`).
+
+ Read more at the
+ [FastAPI docs for Metadata and Docs URLs](https://fastapi.tiangolo.com/tutorial/metadata/#metadata-for-api).
+
+ **Example**
+
+ ```python
+ app = FastAPI(
+ contact={
+ "name": "Deadpoolio the Amazing",
+ "url": "http://x-force.example.com/contact/",
+ "email": "dp@x-force.example.com",
+ }
+ )
+ ```
+ """
+ ),
+ ] = None,
+ license_info: Annotated[
+ Optional[Dict[str, Union[str, Any]]],
+ Doc(
+ """
+ A dictionary with the license information for the exposed API.
+
+ It can contain several fields.
+
+ * `name`: (`str`) **REQUIRED** (if a `license_info` is set). The
+ license name used for the API.
+ * `identifier`: (`str`) An [SPDX](https://spdx.dev/) license expression
+ for the API. The `identifier` field is mutually exclusive of the `url`
+ field. Available since OpenAPI 3.1.0, FastAPI 0.99.0.
+ * `url`: (`str`) A URL to the license used for the API. This MUST be
+ the format of a URL.
+
+ It will be added to the generated OpenAPI (e.g. visible at `/docs`).
+
+ Read more at the
+ [FastAPI docs for Metadata and Docs URLs](https://fastapi.tiangolo.com/tutorial/metadata/#metadata-for-api).
+
+ **Example**
+
+ ```python
+ app = FastAPI(
+ license_info={
+ "name": "Apache 2.0",
+ "url": "https://www.apache.org/licenses/LICENSE-2.0.html",
+ }
+ )
+ ```
+ """
+ ),
+ ] = None,
+ openapi_prefix: Annotated[
+ str,
+ Doc(
+ """
+ A URL prefix for the OpenAPI URL.
+ """
+ ),
+ deprecated(
+ """
+ "openapi_prefix" has been deprecated in favor of "root_path", which
+ follows more closely the ASGI standard, is simpler, and more
+ automatic.
+ """
+ ),
+ ] = "",
+ root_path: Annotated[
+ str,
+ Doc(
+ """
+ A path prefix handled by a proxy that is not seen by the application
+ but is seen by external clients, which affects things like Swagger UI.
+
+ Read more about it at the
+ [FastAPI docs for Behind a Proxy](https://fastapi.tiangolo.com/advanced/behind-a-proxy/).
+
+ **Example**
+
+ ```python
+ from fastapi import FastAPI
+
+ app = FastAPI(root_path="/api/v1")
+ ```
+ """
+ ),
+ ] = "",
+ root_path_in_servers: Annotated[
+ bool,
+ Doc(
+ """
+ To disable automatically generating the URLs in the `servers` field
+ in the autogenerated OpenAPI using the `root_path`.
+
+ Read more about it in the
+ [FastAPI docs for Behind a Proxy](https://fastapi.tiangolo.com/advanced/behind-a-proxy/#disable-automatic-server-from-root_path).
+
+ **Example**
+
+ ```python
+ from fastapi import FastAPI
+
+ app = FastAPI(root_path_in_servers=False)
+ ```
+ """
+ ),
+ ] = True,
+ responses: Annotated[
+ Optional[Dict[Union[int, str], Dict[str, Any]]],
+ Doc(
+ """
+ Additional responses to be shown in OpenAPI.
+
+ It will be added to the generated OpenAPI (e.g. visible at `/docs`).
+
+ Read more about it in the
+ [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/).
+
+ And in the
+ [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).
+ """
+ ),
+ ] = None,
+ callbacks: Annotated[
+ Optional[List[BaseRoute]],
+ Doc(
+ """
+ OpenAPI callbacks that should apply to all *path operations*.
+
+ It will be added to the generated OpenAPI (e.g. visible at `/docs`).
+
+ Read more about it in the
+ [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).
+ """
+ ),
+ ] = None,
+ webhooks: Annotated[
+ Optional[routing.APIRouter],
+ Doc(
+ """
+ Add OpenAPI webhooks. This is similar to `callbacks` but it doesn't
+ depend on specific *path operations*.
+
+ It will be added to the generated OpenAPI (e.g. visible at `/docs`).
+
+ **Note**: This is available since OpenAPI 3.1.0, FastAPI 0.99.0.
+
+ Read more about it in the
+ [FastAPI docs for OpenAPI Webhooks](https://fastapi.tiangolo.com/advanced/openapi-webhooks/).
+ """
+ ),
+ ] = None,
+ deprecated: Annotated[
+ Optional[bool],
+ Doc(
+ """
+ Mark all *path operations* as deprecated. You probably don't need it,
+ but it's available.
+
+ It will be added to the generated OpenAPI (e.g. visible at `/docs`).
+
+ Read more about it in the
+ [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).
+ """
+ ),
+ ] = None,
+ include_in_schema: Annotated[
+ bool,
+ Doc(
+ """
+ To include (or not) all the *path operations* in the generated OpenAPI.
+ You probably don't need it, but it's available.
+
+ This affects the generated OpenAPI (e.g. visible at `/docs`).
+
+ Read more about it in the
+ [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).
+ """
+ ),
+ ] = True,
+ swagger_ui_parameters: Annotated[
+ Optional[Dict[str, Any]],
+ Doc(
+ """
+ Parameters to configure Swagger UI, the autogenerated interactive API
+ documentation (by default at `/docs`).
+
+ Read more about it in the
+ [FastAPI docs about how to Configure Swagger UI](https://fastapi.tiangolo.com/how-to/configure-swagger-ui/).
+ """
+ ),
+ ] = None,
+ generate_unique_id_function: Annotated[
+ Callable[[routing.APIRoute], str],
+ Doc(
+ """
+ Customize the function used to generate unique IDs for the *path
+ operations* shown in the generated OpenAPI.
+
+ This is particularly useful when automatically generating clients or
+ SDKs for your API.
+
+ Read more about it in the
+ [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).
+ """
+ ),
+ ] = Default(generate_unique_id),
+ separate_input_output_schemas: Annotated[
+ bool,
+ Doc(
+ """
+ Whether to generate separate OpenAPI schemas for request body and
+ response body when the results would be more precise.
+
+ This is particularly useful when automatically generating clients.
+
+ For example, if you have a model like:
+
+ ```python
+ from pydantic import BaseModel
+
+ class Item(BaseModel):
+ name: str
+ tags: list[str] = []
+ ```
+
+ When `Item` is used for input, a request body, `tags` is not required,
+ the client doesn't have to provide it.
+
+ But when using `Item` for output, for a response body, `tags` is always
+ available because it has a default value, even if it's just an empty
+ list. So, the client should be able to always expect it.
+
+ In this case, there would be two different schemas, one for input and
+ another one for output.
+ """
+ ),
+ ] = True,
+ **extra: Annotated[
+ Any,
+ Doc(
+ """
+ Extra keyword arguments to be stored in the app, not used by FastAPI
+ anywhere.
+ """
+ ),
+ ],
) -> None:
self.debug = debug
self.title = title
@@ -111,8 +840,39 @@ class FastAPI(Starlette):
self.swagger_ui_init_oauth = swagger_ui_init_oauth
self.swagger_ui_parameters = swagger_ui_parameters
self.servers = servers or []
+ self.separate_input_output_schemas = separate_input_output_schemas
self.extra = extra
- self.openapi_version = "3.1.0"
+ self.openapi_version: Annotated[
+ str,
+ Doc(
+ """
+ The version string of OpenAPI.
+
+ FastAPI will generate OpenAPI version 3.1.0, and will output that as
+ the OpenAPI version. But some tools, even though they might be
+ compatible with OpenAPI 3.1.0, might not recognize it as a valid.
+
+ So you could override this value to trick those tools into using
+ the generated OpenAPI. Have in mind that this is a hack. But if you
+ avoid using features added in OpenAPI 3.1.0, it might work for your
+ use case.
+
+ This is not passed as a parameter to the `FastAPI` class to avoid
+ giving the false idea that FastAPI would generate a different OpenAPI
+ schema. It is only available as an attribute.
+
+ **Example**
+
+ ```python
+ from fastapi import FastAPI
+
+ app = FastAPI()
+
+ app.openapi_version = "3.0.2"
+ ```
+ """
+ ),
+ ] = "3.1.0"
self.openapi_schema: Optional[Dict[str, Any]] = None
if self.openapi_url:
assert self.title, "A title must be provided for OpenAPI, e.g.: 'My API'"
@@ -125,10 +885,55 @@ class FastAPI(Starlette):
"automatic. Check the docs at "
"https://fastapi.tiangolo.com/advanced/sub-applications/"
)
- self.webhooks = webhooks or routing.APIRouter()
+ self.webhooks: Annotated[
+ routing.APIRouter,
+ Doc(
+ """
+ The `app.webhooks` attribute is an `APIRouter` with the *path
+ operations* that will be used just for documentation of webhooks.
+
+ Read more about it in the
+ [FastAPI docs for OpenAPI Webhooks](https://fastapi.tiangolo.com/advanced/openapi-webhooks/).
+ """
+ ),
+ ] = (
+ webhooks or routing.APIRouter()
+ )
self.root_path = root_path or openapi_prefix
- self.state: State = State()
- self.dependency_overrides: Dict[Callable[..., Any], Callable[..., Any]] = {}
+ self.state: Annotated[
+ State,
+ Doc(
+ """
+ A state object for the application. This is the same object for the
+ entire application, it doesn't change from request to request.
+
+ You normally woudln't use this in FastAPI, for most of the cases you
+ would instead use FastAPI dependencies.
+
+ This is simply inherited from Starlette.
+
+ Read more about it in the
+ [Starlette docs for Applications](https://www.starlette.io/applications/#storing-state-on-the-app-instance).
+ """
+ ),
+ ] = State()
+ self.dependency_overrides: Annotated[
+ Dict[Callable[..., Any], Callable[..., Any]],
+ Doc(
+ """
+ A dictionary with overrides for the dependencies.
+
+ Each key is the original dependency callable, and the value is the
+ actual dependency that should be called.
+
+ This is for testing, to replace expensive dependencies with testing
+ versions.
+
+ Read more about it in the
+ [FastAPI docs for Testing Dependencies with Overrides](https://fastapi.tiangolo.com/advanced/testing-dependencies/).
+ """
+ ),
+ ] = {}
self.router: routing.APIRouter = routing.APIRouter(
routes=routes,
redirect_slashes=redirect_slashes,
@@ -187,20 +992,20 @@ class FastAPI(Starlette):
# contextvars.
# This needs to happen after user middlewares because those create a
# new contextvars context copy by using a new AnyIO task group.
- # The initial part of dependencies with yield is executed in the
- # FastAPI code, inside all the middlewares, but the teardown part
- # (after yield) is executed in the AsyncExitStack in this middleware,
- # if the AsyncExitStack lived outside of the custom middlewares and
- # contextvars were set in a dependency with yield in that internal
+ # The initial part of dependencies with 'yield' is executed in the
+ # FastAPI code, inside all the middlewares. However, the teardown part
+ # (after 'yield') is executed in the AsyncExitStack in this middleware.
+ # If the AsyncExitStack lived outside of the custom middlewares and
+ # contextvars were set in a dependency with 'yield' in that internal
# contextvars context, the values would not be available in the
- # outside context of the AsyncExitStack.
- # By putting the middleware and the AsyncExitStack here, inside all
- # user middlewares, the code before and after yield in dependencies
- # with yield is executed in the same contextvars context, so all values
- # set in contextvars before yield is still available after yield as
- # would be expected.
+ # outer context of the AsyncExitStack.
+ # By placing the middleware and the AsyncExitStack here, inside all
+ # user middlewares, the code before and after 'yield' in dependencies
+ # with 'yield' is executed in the same contextvars context. Thus, all values
+ # set in contextvars before 'yield' are still available after 'yield,' as
+ # expected.
# Additionally, by having this AsyncExitStack here, after the
- # ExceptionMiddleware, now dependencies can catch handled exceptions,
+ # ExceptionMiddleware, dependencies can now catch handled exceptions,
# e.g. HTTPException, to customize the teardown code (e.g. DB session
# rollback).
Middleware(AsyncExitStackMiddleware),
@@ -213,6 +1018,19 @@ class FastAPI(Starlette):
return app
def openapi(self) -> Dict[str, Any]:
+ """
+ Generate the OpenAPI schema of the application. This is called by FastAPI
+ internally.
+
+ The first time it is called it stores the result in the attribute
+ `app.openapi_schema`, and next times it is called, it just returns that same
+ result. To avoid the cost of generating the schema every time.
+
+ If you need to modify the generated OpenAPI schema, you could modify it.
+
+ Read more in the
+ [FastAPI docs for OpenAPI](https://fastapi.tiangolo.com/how-to/extending-openapi/).
+ """
if not self.openapi_schema:
self.openapi_schema = get_openapi(
title=self.title,
@@ -227,6 +1045,7 @@ class FastAPI(Starlette):
webhooks=self.webhooks.routes,
tags=self.openapi_tags,
servers=self.servers,
+ separate_input_output_schemas=self.separate_input_output_schemas,
)
return self.openapi_schema
@@ -424,11 +1243,58 @@ class FastAPI(Starlette):
def websocket(
self,
- path: str,
- name: Optional[str] = None,
+ path: Annotated[
+ str,
+ Doc(
+ """
+ WebSocket path.
+ """
+ ),
+ ],
+ name: Annotated[
+ Optional[str],
+ Doc(
+ """
+ A name for the WebSocket. Only used internally.
+ """
+ ),
+ ] = None,
*,
- dependencies: Optional[Sequence[Depends]] = None,
+ dependencies: Annotated[
+ Optional[Sequence[Depends]],
+ Doc(
+ """
+ A list of dependencies (using `Depends()`) to be used for this
+ WebSocket.
+
+ Read more about it in the
+ [FastAPI docs for WebSockets](https://fastapi.tiangolo.com/advanced/websockets/).
+ """
+ ),
+ ] = None,
) -> Callable[[DecoratedCallable], DecoratedCallable]:
+ """
+ Decorate a WebSocket function.
+
+ Read more about it in the
+ [FastAPI docs for WebSockets](https://fastapi.tiangolo.com/advanced/websockets/).
+
+ **Example**
+
+ ```python
+ from fastapi import FastAPI, WebSocket
+
+ app = FastAPI()
+
+ @app.websocket("/ws")
+ async def websocket_endpoint(websocket: WebSocket):
+ await websocket.accept()
+ while True:
+ data = await websocket.receive_text()
+ await websocket.send_text(f"Message text was: {data}")
+ ```
+ """
+
def decorator(func: DecoratedCallable) -> DecoratedCallable:
self.add_api_websocket_route(
path,
@@ -442,20 +1308,196 @@ class FastAPI(Starlette):
def include_router(
self,
- router: routing.APIRouter,
+ router: Annotated[routing.APIRouter, Doc("The `APIRouter` to include.")],
*,
- prefix: str = "",
- tags: Optional[List[Union[str, Enum]]] = None,
- dependencies: Optional[Sequence[Depends]] = None,
- responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,
- deprecated: Optional[bool] = None,
- include_in_schema: bool = True,
- default_response_class: Type[Response] = Default(JSONResponse),
- callbacks: Optional[List[BaseRoute]] = None,
- generate_unique_id_function: Callable[[routing.APIRoute], str] = Default(
- generate_unique_id
- ),
+ prefix: Annotated[str, Doc("An optional path prefix for the router.")] = "",
+ tags: Annotated[
+ Optional[List[Union[str, Enum]]],
+ Doc(
+ """
+ A list of tags to be applied to all the *path operations* in this
+ router.
+
+ It will be added to the generated OpenAPI (e.g. visible at `/docs`).
+
+ Read more about it in the
+ [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).
+ """
+ ),
+ ] = None,
+ dependencies: Annotated[
+ Optional[Sequence[Depends]],
+ Doc(
+ """
+ A list of dependencies (using `Depends()`) to be applied to all the
+ *path operations* in this router.
+
+ Read more about it in the
+ [FastAPI docs for Bigger Applications - Multiple Files](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).
+
+ **Example**
+
+ ```python
+ from fastapi import Depends, FastAPI
+
+ from .dependencies import get_token_header
+ from .internal import admin
+
+ app = FastAPI()
+
+ app.include_router(
+ admin.router,
+ dependencies=[Depends(get_token_header)],
+ )
+ ```
+ """
+ ),
+ ] = None,
+ responses: Annotated[
+ Optional[Dict[Union[int, str], Dict[str, Any]]],
+ Doc(
+ """
+ Additional responses to be shown in OpenAPI.
+
+ It will be added to the generated OpenAPI (e.g. visible at `/docs`).
+
+ Read more about it in the
+ [FastAPI docs for Additional Responses in OpenAPI](https://fastapi.tiangolo.com/advanced/additional-responses/).
+
+ And in the
+ [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/#include-an-apirouter-with-a-custom-prefix-tags-responses-and-dependencies).
+ """
+ ),
+ ] = None,
+ deprecated: Annotated[
+ Optional[bool],
+ Doc(
+ """
+ Mark all the *path operations* in this router as deprecated.
+
+ It will be added to the generated OpenAPI (e.g. visible at `/docs`).
+
+ **Example**
+
+ ```python
+ from fastapi import FastAPI
+
+ from .internal import old_api
+
+ app = FastAPI()
+
+ app.include_router(
+ old_api.router,
+ deprecated=True,
+ )
+ ```
+ """
+ ),
+ ] = None,
+ include_in_schema: Annotated[
+ bool,
+ Doc(
+ """
+ Include (or not) all the *path operations* in this router in the
+ generated OpenAPI schema.
+
+ This affects the generated OpenAPI (e.g. visible at `/docs`).
+
+ **Example**
+
+ ```python
+ from fastapi import FastAPI
+
+ from .internal import old_api
+
+ app = FastAPI()
+
+ app.include_router(
+ old_api.router,
+ include_in_schema=False,
+ )
+ ```
+ """
+ ),
+ ] = True,
+ default_response_class: Annotated[
+ Type[Response],
+ Doc(
+ """
+ Default response class to be used for the *path operations* in this
+ router.
+
+ Read more in the
+ [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#default-response-class).
+
+ **Example**
+
+ ```python
+ from fastapi import FastAPI
+ from fastapi.responses import ORJSONResponse
+
+ from .internal import old_api
+
+ app = FastAPI()
+
+ app.include_router(
+ old_api.router,
+ default_response_class=ORJSONResponse,
+ )
+ ```
+ """
+ ),
+ ] = Default(JSONResponse),
+ callbacks: Annotated[
+ Optional[List[BaseRoute]],
+ Doc(
+ """
+ List of *path operations* that will be used as OpenAPI callbacks.
+
+ This is only for OpenAPI documentation, the callbacks won't be used
+ directly.
+
+ It will be added to the generated OpenAPI (e.g. visible at `/docs`).
+
+ Read more about it in the
+ [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).
+ """
+ ),
+ ] = None,
+ generate_unique_id_function: Annotated[
+ Callable[[routing.APIRoute], str],
+ Doc(
+ """
+ Customize the function used to generate unique IDs for the *path
+ operations* shown in the generated OpenAPI.
+
+ This is particularly useful when automatically generating clients or
+ SDKs for your API.
+
+ Read more about it in the
+ [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).
+ """
+ ),
+ ] = Default(generate_unique_id),
) -> None:
+ """
+ Include an `APIRouter` in the same app.
+
+ Read more about it in the
+ [FastAPI docs for Bigger Applications](https://fastapi.tiangolo.com/tutorial/bigger-applications/).
+
+ ## Example
+
+ ```python
+ from fastapi import FastAPI
+
+ from .users import users_router
+
+ app = FastAPI()
+
+ app.include_router(users_router)
+ ```
+ """
self.router.include_router(
router,
prefix=prefix,
@@ -471,33 +1513,351 @@ class FastAPI(Starlette):
def get(
self,
- path: str,
+ path: Annotated[
+ str,
+ Doc(
+ """
+ The URL path to be used for this *path operation*.
+
+ For example, in `http://example.com/items`, the path is `/items`.
+ """
+ ),
+ ],
*,
- response_model: Any = Default(None),
- status_code: Optional[int] = None,
- tags: Optional[List[Union[str, Enum]]] = None,
- dependencies: Optional[Sequence[Depends]] = None,
- summary: Optional[str] = None,
- description: Optional[str] = None,
- response_description: str = "Successful Response",
- responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,
- deprecated: Optional[bool] = None,
- operation_id: Optional[str] = None,
- response_model_include: Optional[IncEx] = None,
- response_model_exclude: Optional[IncEx] = None,
- response_model_by_alias: bool = True,
- response_model_exclude_unset: bool = False,
- response_model_exclude_defaults: bool = False,
- response_model_exclude_none: bool = False,
- include_in_schema: bool = True,
- response_class: Type[Response] = Default(JSONResponse),
- name: Optional[str] = None,
- callbacks: Optional[List[BaseRoute]] = None,
- openapi_extra: Optional[Dict[str, Any]] = None,
- generate_unique_id_function: Callable[[routing.APIRoute], str] = Default(
- generate_unique_id
- ),
+ response_model: Annotated[
+ Any,
+ Doc(
+ """
+ The type to use for the response.
+
+ It could be any valid Pydantic *field* type. So, it doesn't have to
+ be a Pydantic model, it could be other things, like a `list`, `dict`,
+ etc.
+
+ It will be used for:
+
+ * Documentation: the generated OpenAPI (and the UI at `/docs`) will
+ show it as the response (JSON Schema).
+ * Serialization: you could return an arbitrary object and the
+ `response_model` would be used to serialize that object into the
+ corresponding JSON.
+ * Filtering: the JSON sent to the client will only contain the data
+ (fields) defined in the `response_model`. If you returned an object
+ that contains an attribute `password` but the `response_model` does
+ not include that field, the JSON sent to the client would not have
+ that `password`.
+ * Validation: whatever you return will be serialized with the
+ `response_model`, converting any data as necessary to generate the
+ corresponding JSON. But if the data in the object returned is not
+ valid, that would mean a violation of the contract with the client,
+ so it's an error from the API developer. So, FastAPI will raise an
+ error and return a 500 error code (Internal Server Error).
+
+ Read more about it in the
+ [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).
+ """
+ ),
+ ] = Default(None),
+ status_code: Annotated[
+ Optional[int],
+ Doc(
+ """
+ The default status code to be used for the response.
+
+ You could override the status code by returning a response directly.
+
+ Read more about it in the
+ [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).
+ """
+ ),
+ ] = None,
+ tags: Annotated[
+ Optional[List[Union[str, Enum]]],
+ Doc(
+ """
+ A list of tags to be applied to the *path operation*.
+
+ It will be added to the generated OpenAPI (e.g. visible at `/docs`).
+
+ Read more about it in the
+ [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).
+ """
+ ),
+ ] = None,
+ dependencies: Annotated[
+ Optional[Sequence[Depends]],
+ Doc(
+ """
+ A list of dependencies (using `Depends()`) to be applied to the
+ *path operation*.
+
+ Read more about it in the
+ [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).
+ """
+ ),
+ ] = None,
+ summary: Annotated[
+ Optional[str],
+ Doc(
+ """
+ A summary for the *path operation*.
+
+ It will be added to the generated OpenAPI (e.g. visible at `/docs`).
+
+ Read more about it in the
+ [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).
+ """
+ ),
+ ] = None,
+ description: Annotated[
+ Optional[str],
+ Doc(
+ """
+ A description for the *path operation*.
+
+ If not provided, it will be extracted automatically from the docstring
+ of the *path operation function*.
+
+ It can contain Markdown.
+
+ It will be added to the generated OpenAPI (e.g. visible at `/docs`).
+
+ Read more about it in the
+ [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).
+ """
+ ),
+ ] = None,
+ response_description: Annotated[
+ str,
+ Doc(
+ """
+ The description for the default response.
+
+ It will be added to the generated OpenAPI (e.g. visible at `/docs`).
+ """
+ ),
+ ] = "Successful Response",
+ responses: Annotated[
+ Optional[Dict[Union[int, str], Dict[str, Any]]],
+ Doc(
+ """
+ Additional responses that could be returned by this *path operation*.
+
+ It will be added to the generated OpenAPI (e.g. visible at `/docs`).
+ """
+ ),
+ ] = None,
+ deprecated: Annotated[
+ Optional[bool],
+ Doc(
+ """
+ Mark this *path operation* as deprecated.
+
+ It will be added to the generated OpenAPI (e.g. visible at `/docs`).
+ """
+ ),
+ ] = None,
+ operation_id: Annotated[
+ Optional[str],
+ Doc(
+ """
+ Custom operation ID to be used by this *path operation*.
+
+ By default, it is generated automatically.
+
+ If you provide a custom operation ID, you need to make sure it is
+ unique for the whole API.
+
+ You can customize the
+ operation ID generation with the parameter
+ `generate_unique_id_function` in the `FastAPI` class.
+
+ Read more about it in the
+ [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).
+ """
+ ),
+ ] = None,
+ response_model_include: Annotated[
+ Optional[IncEx],
+ Doc(
+ """
+ Configuration passed to Pydantic to include only certain fields in the
+ response data.
+
+ Read more about it in the
+ [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).
+ """
+ ),
+ ] = None,
+ response_model_exclude: Annotated[
+ Optional[IncEx],
+ Doc(
+ """
+ Configuration passed to Pydantic to exclude certain fields in the
+ response data.
+
+ Read more about it in the
+ [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).
+ """
+ ),
+ ] = None,
+ response_model_by_alias: Annotated[
+ bool,
+ Doc(
+ """
+ Configuration passed to Pydantic to define if the response model
+ should be serialized by alias when an alias is used.
+
+ Read more about it in the
+ [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).
+ """
+ ),
+ ] = True,
+ response_model_exclude_unset: Annotated[
+ bool,
+ Doc(
+ """
+ Configuration passed to Pydantic to define if the response data
+ should have all the fields, including the ones that were not set and
+ have their default values. This is different from
+ `response_model_exclude_defaults` in that if the fields are set,
+ they will be included in the response, even if the value is the same
+ as the default.
+
+ When `True`, default values are omitted from the response.
+
+ Read more about it in the
+ [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).
+ """
+ ),
+ ] = False,
+ response_model_exclude_defaults: Annotated[
+ bool,
+ Doc(
+ """
+ Configuration passed to Pydantic to define if the response data
+ should have all the fields, including the ones that have the same value
+ as the default. This is different from `response_model_exclude_unset`
+ in that if the fields are set but contain the same default values,
+ they will be excluded from the response.
+
+ When `True`, default values are omitted from the response.
+
+ Read more about it in the
+ [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).
+ """
+ ),
+ ] = False,
+ response_model_exclude_none: Annotated[
+ bool,
+ Doc(
+ """
+ Configuration passed to Pydantic to define if the response data should
+ exclude fields set to `None`.
+
+ This is much simpler (less smart) than `response_model_exclude_unset`
+ and `response_model_exclude_defaults`. You probably want to use one of
+ those two instead of this one, as those allow returning `None` values
+ when it makes sense.
+
+ Read more about it in the
+ [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).
+ """
+ ),
+ ] = False,
+ include_in_schema: Annotated[
+ bool,
+ Doc(
+ """
+ Include this *path operation* in the generated OpenAPI schema.
+
+ This affects the generated OpenAPI (e.g. visible at `/docs`).
+
+ Read more about it in the
+ [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).
+ """
+ ),
+ ] = True,
+ response_class: Annotated[
+ Type[Response],
+ Doc(
+ """
+ Response class to be used for this *path operation*.
+
+ This will not be used if you return a response directly.
+
+ Read more about it in the
+ [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).
+ """
+ ),
+ ] = Default(JSONResponse),
+ name: Annotated[
+ Optional[str],
+ Doc(
+ """
+ Name for this *path operation*. Only used internally.
+ """
+ ),
+ ] = None,
+ callbacks: Annotated[
+ Optional[List[BaseRoute]],
+ Doc(
+ """
+ List of *path operations* that will be used as OpenAPI callbacks.
+
+ This is only for OpenAPI documentation, the callbacks won't be used
+ directly.
+
+ It will be added to the generated OpenAPI (e.g. visible at `/docs`).
+
+ Read more about it in the
+ [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).
+ """
+ ),
+ ] = None,
+ openapi_extra: Annotated[
+ Optional[Dict[str, Any]],
+ Doc(
+ """
+ Extra metadata to be included in the OpenAPI schema for this *path
+ operation*.
+
+ Read more about it in the
+ [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).
+ """
+ ),
+ ] = None,
+ generate_unique_id_function: Annotated[
+ Callable[[routing.APIRoute], str],
+ Doc(
+ """
+ Customize the function used to generate unique IDs for the *path
+ operations* shown in the generated OpenAPI.
+
+ This is particularly useful when automatically generating clients or
+ SDKs for your API.
+
+ Read more about it in the
+ [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).
+ """
+ ),
+ ] = Default(generate_unique_id),
) -> Callable[[DecoratedCallable], DecoratedCallable]:
+ """
+ Add a *path operation* using an HTTP GET operation.
+
+ ## Example
+
+ ```python
+ from fastapi import FastAPI
+
+ app = FastAPI()
+
+ @app.get("/items/")
+ def read_items():
+ return [{"name": "Empanada"}, {"name": "Arepa"}]
+ ```
+ """
return self.router.get(
path,
response_model=response_model,
@@ -526,33 +1886,356 @@ class FastAPI(Starlette):
def put(
self,
- path: str,
+ path: Annotated[
+ str,
+ Doc(
+ """
+ The URL path to be used for this *path operation*.
+
+ For example, in `http://example.com/items`, the path is `/items`.
+ """
+ ),
+ ],
*,
- response_model: Any = Default(None),
- status_code: Optional[int] = None,
- tags: Optional[List[Union[str, Enum]]] = None,
- dependencies: Optional[Sequence[Depends]] = None,
- summary: Optional[str] = None,
- description: Optional[str] = None,
- response_description: str = "Successful Response",
- responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,
- deprecated: Optional[bool] = None,
- operation_id: Optional[str] = None,
- response_model_include: Optional[IncEx] = None,
- response_model_exclude: Optional[IncEx] = None,
- response_model_by_alias: bool = True,
- response_model_exclude_unset: bool = False,
- response_model_exclude_defaults: bool = False,
- response_model_exclude_none: bool = False,
- include_in_schema: bool = True,
- response_class: Type[Response] = Default(JSONResponse),
- name: Optional[str] = None,
- callbacks: Optional[List[BaseRoute]] = None,
- openapi_extra: Optional[Dict[str, Any]] = None,
- generate_unique_id_function: Callable[[routing.APIRoute], str] = Default(
- generate_unique_id
- ),
+ response_model: Annotated[
+ Any,
+ Doc(
+ """
+ The type to use for the response.
+
+ It could be any valid Pydantic *field* type. So, it doesn't have to
+ be a Pydantic model, it could be other things, like a `list`, `dict`,
+ etc.
+
+ It will be used for:
+
+ * Documentation: the generated OpenAPI (and the UI at `/docs`) will
+ show it as the response (JSON Schema).
+ * Serialization: you could return an arbitrary object and the
+ `response_model` would be used to serialize that object into the
+ corresponding JSON.
+ * Filtering: the JSON sent to the client will only contain the data
+ (fields) defined in the `response_model`. If you returned an object
+ that contains an attribute `password` but the `response_model` does
+ not include that field, the JSON sent to the client would not have
+ that `password`.
+ * Validation: whatever you return will be serialized with the
+ `response_model`, converting any data as necessary to generate the
+ corresponding JSON. But if the data in the object returned is not
+ valid, that would mean a violation of the contract with the client,
+ so it's an error from the API developer. So, FastAPI will raise an
+ error and return a 500 error code (Internal Server Error).
+
+ Read more about it in the
+ [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).
+ """
+ ),
+ ] = Default(None),
+ status_code: Annotated[
+ Optional[int],
+ Doc(
+ """
+ The default status code to be used for the response.
+
+ You could override the status code by returning a response directly.
+
+ Read more about it in the
+ [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).
+ """
+ ),
+ ] = None,
+ tags: Annotated[
+ Optional[List[Union[str, Enum]]],
+ Doc(
+ """
+ A list of tags to be applied to the *path operation*.
+
+ It will be added to the generated OpenAPI (e.g. visible at `/docs`).
+
+ Read more about it in the
+ [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).
+ """
+ ),
+ ] = None,
+ dependencies: Annotated[
+ Optional[Sequence[Depends]],
+ Doc(
+ """
+ A list of dependencies (using `Depends()`) to be applied to the
+ *path operation*.
+
+ Read more about it in the
+ [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).
+ """
+ ),
+ ] = None,
+ summary: Annotated[
+ Optional[str],
+ Doc(
+ """
+ A summary for the *path operation*.
+
+ It will be added to the generated OpenAPI (e.g. visible at `/docs`).
+
+ Read more about it in the
+ [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).
+ """
+ ),
+ ] = None,
+ description: Annotated[
+ Optional[str],
+ Doc(
+ """
+ A description for the *path operation*.
+
+ If not provided, it will be extracted automatically from the docstring
+ of the *path operation function*.
+
+ It can contain Markdown.
+
+ It will be added to the generated OpenAPI (e.g. visible at `/docs`).
+
+ Read more about it in the
+ [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).
+ """
+ ),
+ ] = None,
+ response_description: Annotated[
+ str,
+ Doc(
+ """
+ The description for the default response.
+
+ It will be added to the generated OpenAPI (e.g. visible at `/docs`).
+ """
+ ),
+ ] = "Successful Response",
+ responses: Annotated[
+ Optional[Dict[Union[int, str], Dict[str, Any]]],
+ Doc(
+ """
+ Additional responses that could be returned by this *path operation*.
+
+ It will be added to the generated OpenAPI (e.g. visible at `/docs`).
+ """
+ ),
+ ] = None,
+ deprecated: Annotated[
+ Optional[bool],
+ Doc(
+ """
+ Mark this *path operation* as deprecated.
+
+ It will be added to the generated OpenAPI (e.g. visible at `/docs`).
+ """
+ ),
+ ] = None,
+ operation_id: Annotated[
+ Optional[str],
+ Doc(
+ """
+ Custom operation ID to be used by this *path operation*.
+
+ By default, it is generated automatically.
+
+ If you provide a custom operation ID, you need to make sure it is
+ unique for the whole API.
+
+ You can customize the
+ operation ID generation with the parameter
+ `generate_unique_id_function` in the `FastAPI` class.
+
+ Read more about it in the
+ [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).
+ """
+ ),
+ ] = None,
+ response_model_include: Annotated[
+ Optional[IncEx],
+ Doc(
+ """
+ Configuration passed to Pydantic to include only certain fields in the
+ response data.
+
+ Read more about it in the
+ [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).
+ """
+ ),
+ ] = None,
+ response_model_exclude: Annotated[
+ Optional[IncEx],
+ Doc(
+ """
+ Configuration passed to Pydantic to exclude certain fields in the
+ response data.
+
+ Read more about it in the
+ [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).
+ """
+ ),
+ ] = None,
+ response_model_by_alias: Annotated[
+ bool,
+ Doc(
+ """
+ Configuration passed to Pydantic to define if the response model
+ should be serialized by alias when an alias is used.
+
+ Read more about it in the
+ [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).
+ """
+ ),
+ ] = True,
+ response_model_exclude_unset: Annotated[
+ bool,
+ Doc(
+ """
+ Configuration passed to Pydantic to define if the response data
+ should have all the fields, including the ones that were not set and
+ have their default values. This is different from
+ `response_model_exclude_defaults` in that if the fields are set,
+ they will be included in the response, even if the value is the same
+ as the default.
+
+ When `True`, default values are omitted from the response.
+
+ Read more about it in the
+ [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).
+ """
+ ),
+ ] = False,
+ response_model_exclude_defaults: Annotated[
+ bool,
+ Doc(
+ """
+ Configuration passed to Pydantic to define if the response data
+ should have all the fields, including the ones that have the same value
+ as the default. This is different from `response_model_exclude_unset`
+ in that if the fields are set but contain the same default values,
+ they will be excluded from the response.
+
+ When `True`, default values are omitted from the response.
+
+ Read more about it in the
+ [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).
+ """
+ ),
+ ] = False,
+ response_model_exclude_none: Annotated[
+ bool,
+ Doc(
+ """
+ Configuration passed to Pydantic to define if the response data should
+ exclude fields set to `None`.
+
+ This is much simpler (less smart) than `response_model_exclude_unset`
+ and `response_model_exclude_defaults`. You probably want to use one of
+ those two instead of this one, as those allow returning `None` values
+ when it makes sense.
+
+ Read more about it in the
+ [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).
+ """
+ ),
+ ] = False,
+ include_in_schema: Annotated[
+ bool,
+ Doc(
+ """
+ Include this *path operation* in the generated OpenAPI schema.
+
+ This affects the generated OpenAPI (e.g. visible at `/docs`).
+
+ Read more about it in the
+ [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).
+ """
+ ),
+ ] = True,
+ response_class: Annotated[
+ Type[Response],
+ Doc(
+ """
+ Response class to be used for this *path operation*.
+
+ This will not be used if you return a response directly.
+
+ Read more about it in the
+ [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).
+ """
+ ),
+ ] = Default(JSONResponse),
+ name: Annotated[
+ Optional[str],
+ Doc(
+ """
+ Name for this *path operation*. Only used internally.
+ """
+ ),
+ ] = None,
+ callbacks: Annotated[
+ Optional[List[BaseRoute]],
+ Doc(
+ """
+ List of *path operations* that will be used as OpenAPI callbacks.
+
+ This is only for OpenAPI documentation, the callbacks won't be used
+ directly.
+
+ It will be added to the generated OpenAPI (e.g. visible at `/docs`).
+
+ Read more about it in the
+ [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).
+ """
+ ),
+ ] = None,
+ openapi_extra: Annotated[
+ Optional[Dict[str, Any]],
+ Doc(
+ """
+ Extra metadata to be included in the OpenAPI schema for this *path
+ operation*.
+
+ Read more about it in the
+ [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).
+ """
+ ),
+ ] = None,
+ generate_unique_id_function: Annotated[
+ Callable[[routing.APIRoute], str],
+ Doc(
+ """
+ Customize the function used to generate unique IDs for the *path
+ operations* shown in the generated OpenAPI.
+
+ This is particularly useful when automatically generating clients or
+ SDKs for your API.
+
+ Read more about it in the
+ [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).
+ """
+ ),
+ ] = Default(generate_unique_id),
) -> Callable[[DecoratedCallable], DecoratedCallable]:
+ """
+ Add a *path operation* using an HTTP PUT operation.
+
+ ## Example
+
+ ```python
+ from fastapi import FastAPI
+ from pydantic import BaseModel
+
+ class Item(BaseModel):
+ name: str
+ description: str | None = None
+
+ app = FastAPI()
+
+ @app.put("/items/{item_id}")
+ def replace_item(item_id: str, item: Item):
+ return {"message": "Item replaced", "id": item_id}
+ ```
+ """
return self.router.put(
path,
response_model=response_model,
@@ -581,33 +2264,356 @@ class FastAPI(Starlette):
def post(
self,
- path: str,
+ path: Annotated[
+ str,
+ Doc(
+ """
+ The URL path to be used for this *path operation*.
+
+ For example, in `http://example.com/items`, the path is `/items`.
+ """
+ ),
+ ],
*,
- response_model: Any = Default(None),
- status_code: Optional[int] = None,
- tags: Optional[List[Union[str, Enum]]] = None,
- dependencies: Optional[Sequence[Depends]] = None,
- summary: Optional[str] = None,
- description: Optional[str] = None,
- response_description: str = "Successful Response",
- responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,
- deprecated: Optional[bool] = None,
- operation_id: Optional[str] = None,
- response_model_include: Optional[IncEx] = None,
- response_model_exclude: Optional[IncEx] = None,
- response_model_by_alias: bool = True,
- response_model_exclude_unset: bool = False,
- response_model_exclude_defaults: bool = False,
- response_model_exclude_none: bool = False,
- include_in_schema: bool = True,
- response_class: Type[Response] = Default(JSONResponse),
- name: Optional[str] = None,
- callbacks: Optional[List[BaseRoute]] = None,
- openapi_extra: Optional[Dict[str, Any]] = None,
- generate_unique_id_function: Callable[[routing.APIRoute], str] = Default(
- generate_unique_id
- ),
+ response_model: Annotated[
+ Any,
+ Doc(
+ """
+ The type to use for the response.
+
+ It could be any valid Pydantic *field* type. So, it doesn't have to
+ be a Pydantic model, it could be other things, like a `list`, `dict`,
+ etc.
+
+ It will be used for:
+
+ * Documentation: the generated OpenAPI (and the UI at `/docs`) will
+ show it as the response (JSON Schema).
+ * Serialization: you could return an arbitrary object and the
+ `response_model` would be used to serialize that object into the
+ corresponding JSON.
+ * Filtering: the JSON sent to the client will only contain the data
+ (fields) defined in the `response_model`. If you returned an object
+ that contains an attribute `password` but the `response_model` does
+ not include that field, the JSON sent to the client would not have
+ that `password`.
+ * Validation: whatever you return will be serialized with the
+ `response_model`, converting any data as necessary to generate the
+ corresponding JSON. But if the data in the object returned is not
+ valid, that would mean a violation of the contract with the client,
+ so it's an error from the API developer. So, FastAPI will raise an
+ error and return a 500 error code (Internal Server Error).
+
+ Read more about it in the
+ [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).
+ """
+ ),
+ ] = Default(None),
+ status_code: Annotated[
+ Optional[int],
+ Doc(
+ """
+ The default status code to be used for the response.
+
+ You could override the status code by returning a response directly.
+
+ Read more about it in the
+ [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).
+ """
+ ),
+ ] = None,
+ tags: Annotated[
+ Optional[List[Union[str, Enum]]],
+ Doc(
+ """
+ A list of tags to be applied to the *path operation*.
+
+ It will be added to the generated OpenAPI (e.g. visible at `/docs`).
+
+ Read more about it in the
+ [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).
+ """
+ ),
+ ] = None,
+ dependencies: Annotated[
+ Optional[Sequence[Depends]],
+ Doc(
+ """
+ A list of dependencies (using `Depends()`) to be applied to the
+ *path operation*.
+
+ Read more about it in the
+ [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).
+ """
+ ),
+ ] = None,
+ summary: Annotated[
+ Optional[str],
+ Doc(
+ """
+ A summary for the *path operation*.
+
+ It will be added to the generated OpenAPI (e.g. visible at `/docs`).
+
+ Read more about it in the
+ [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).
+ """
+ ),
+ ] = None,
+ description: Annotated[
+ Optional[str],
+ Doc(
+ """
+ A description for the *path operation*.
+
+ If not provided, it will be extracted automatically from the docstring
+ of the *path operation function*.
+
+ It can contain Markdown.
+
+ It will be added to the generated OpenAPI (e.g. visible at `/docs`).
+
+ Read more about it in the
+ [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).
+ """
+ ),
+ ] = None,
+ response_description: Annotated[
+ str,
+ Doc(
+ """
+ The description for the default response.
+
+ It will be added to the generated OpenAPI (e.g. visible at `/docs`).
+ """
+ ),
+ ] = "Successful Response",
+ responses: Annotated[
+ Optional[Dict[Union[int, str], Dict[str, Any]]],
+ Doc(
+ """
+ Additional responses that could be returned by this *path operation*.
+
+ It will be added to the generated OpenAPI (e.g. visible at `/docs`).
+ """
+ ),
+ ] = None,
+ deprecated: Annotated[
+ Optional[bool],
+ Doc(
+ """
+ Mark this *path operation* as deprecated.
+
+ It will be added to the generated OpenAPI (e.g. visible at `/docs`).
+ """
+ ),
+ ] = None,
+ operation_id: Annotated[
+ Optional[str],
+ Doc(
+ """
+ Custom operation ID to be used by this *path operation*.
+
+ By default, it is generated automatically.
+
+ If you provide a custom operation ID, you need to make sure it is
+ unique for the whole API.
+
+ You can customize the
+ operation ID generation with the parameter
+ `generate_unique_id_function` in the `FastAPI` class.
+
+ Read more about it in the
+ [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).
+ """
+ ),
+ ] = None,
+ response_model_include: Annotated[
+ Optional[IncEx],
+ Doc(
+ """
+ Configuration passed to Pydantic to include only certain fields in the
+ response data.
+
+ Read more about it in the
+ [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).
+ """
+ ),
+ ] = None,
+ response_model_exclude: Annotated[
+ Optional[IncEx],
+ Doc(
+ """
+ Configuration passed to Pydantic to exclude certain fields in the
+ response data.
+
+ Read more about it in the
+ [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).
+ """
+ ),
+ ] = None,
+ response_model_by_alias: Annotated[
+ bool,
+ Doc(
+ """
+ Configuration passed to Pydantic to define if the response model
+ should be serialized by alias when an alias is used.
+
+ Read more about it in the
+ [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).
+ """
+ ),
+ ] = True,
+ response_model_exclude_unset: Annotated[
+ bool,
+ Doc(
+ """
+ Configuration passed to Pydantic to define if the response data
+ should have all the fields, including the ones that were not set and
+ have their default values. This is different from
+ `response_model_exclude_defaults` in that if the fields are set,
+ they will be included in the response, even if the value is the same
+ as the default.
+
+ When `True`, default values are omitted from the response.
+
+ Read more about it in the
+ [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).
+ """
+ ),
+ ] = False,
+ response_model_exclude_defaults: Annotated[
+ bool,
+ Doc(
+ """
+ Configuration passed to Pydantic to define if the response data
+ should have all the fields, including the ones that have the same value
+ as the default. This is different from `response_model_exclude_unset`
+ in that if the fields are set but contain the same default values,
+ they will be excluded from the response.
+
+ When `True`, default values are omitted from the response.
+
+ Read more about it in the
+ [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).
+ """
+ ),
+ ] = False,
+ response_model_exclude_none: Annotated[
+ bool,
+ Doc(
+ """
+ Configuration passed to Pydantic to define if the response data should
+ exclude fields set to `None`.
+
+ This is much simpler (less smart) than `response_model_exclude_unset`
+ and `response_model_exclude_defaults`. You probably want to use one of
+ those two instead of this one, as those allow returning `None` values
+ when it makes sense.
+
+ Read more about it in the
+ [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).
+ """
+ ),
+ ] = False,
+ include_in_schema: Annotated[
+ bool,
+ Doc(
+ """
+ Include this *path operation* in the generated OpenAPI schema.
+
+ This affects the generated OpenAPI (e.g. visible at `/docs`).
+
+ Read more about it in the
+ [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).
+ """
+ ),
+ ] = True,
+ response_class: Annotated[
+ Type[Response],
+ Doc(
+ """
+ Response class to be used for this *path operation*.
+
+ This will not be used if you return a response directly.
+
+ Read more about it in the
+ [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).
+ """
+ ),
+ ] = Default(JSONResponse),
+ name: Annotated[
+ Optional[str],
+ Doc(
+ """
+ Name for this *path operation*. Only used internally.
+ """
+ ),
+ ] = None,
+ callbacks: Annotated[
+ Optional[List[BaseRoute]],
+ Doc(
+ """
+ List of *path operations* that will be used as OpenAPI callbacks.
+
+ This is only for OpenAPI documentation, the callbacks won't be used
+ directly.
+
+ It will be added to the generated OpenAPI (e.g. visible at `/docs`).
+
+ Read more about it in the
+ [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).
+ """
+ ),
+ ] = None,
+ openapi_extra: Annotated[
+ Optional[Dict[str, Any]],
+ Doc(
+ """
+ Extra metadata to be included in the OpenAPI schema for this *path
+ operation*.
+
+ Read more about it in the
+ [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).
+ """
+ ),
+ ] = None,
+ generate_unique_id_function: Annotated[
+ Callable[[routing.APIRoute], str],
+ Doc(
+ """
+ Customize the function used to generate unique IDs for the *path
+ operations* shown in the generated OpenAPI.
+
+ This is particularly useful when automatically generating clients or
+ SDKs for your API.
+
+ Read more about it in the
+ [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).
+ """
+ ),
+ ] = Default(generate_unique_id),
) -> Callable[[DecoratedCallable], DecoratedCallable]:
+ """
+ Add a *path operation* using an HTTP POST operation.
+
+ ## Example
+
+ ```python
+ from fastapi import FastAPI
+ from pydantic import BaseModel
+
+ class Item(BaseModel):
+ name: str
+ description: str | None = None
+
+ app = FastAPI()
+
+ @app.post("/items/")
+ def create_item(item: Item):
+ return {"message": "Item created"}
+ ```
+ """
return self.router.post(
path,
response_model=response_model,
@@ -636,33 +2642,351 @@ class FastAPI(Starlette):
def delete(
self,
- path: str,
+ path: Annotated[
+ str,
+ Doc(
+ """
+ The URL path to be used for this *path operation*.
+
+ For example, in `http://example.com/items`, the path is `/items`.
+ """
+ ),
+ ],
*,
- response_model: Any = Default(None),
- status_code: Optional[int] = None,
- tags: Optional[List[Union[str, Enum]]] = None,
- dependencies: Optional[Sequence[Depends]] = None,
- summary: Optional[str] = None,
- description: Optional[str] = None,
- response_description: str = "Successful Response",
- responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,
- deprecated: Optional[bool] = None,
- operation_id: Optional[str] = None,
- response_model_include: Optional[IncEx] = None,
- response_model_exclude: Optional[IncEx] = None,
- response_model_by_alias: bool = True,
- response_model_exclude_unset: bool = False,
- response_model_exclude_defaults: bool = False,
- response_model_exclude_none: bool = False,
- include_in_schema: bool = True,
- response_class: Type[Response] = Default(JSONResponse),
- name: Optional[str] = None,
- callbacks: Optional[List[BaseRoute]] = None,
- openapi_extra: Optional[Dict[str, Any]] = None,
- generate_unique_id_function: Callable[[routing.APIRoute], str] = Default(
- generate_unique_id
- ),
+ response_model: Annotated[
+ Any,
+ Doc(
+ """
+ The type to use for the response.
+
+ It could be any valid Pydantic *field* type. So, it doesn't have to
+ be a Pydantic model, it could be other things, like a `list`, `dict`,
+ etc.
+
+ It will be used for:
+
+ * Documentation: the generated OpenAPI (and the UI at `/docs`) will
+ show it as the response (JSON Schema).
+ * Serialization: you could return an arbitrary object and the
+ `response_model` would be used to serialize that object into the
+ corresponding JSON.
+ * Filtering: the JSON sent to the client will only contain the data
+ (fields) defined in the `response_model`. If you returned an object
+ that contains an attribute `password` but the `response_model` does
+ not include that field, the JSON sent to the client would not have
+ that `password`.
+ * Validation: whatever you return will be serialized with the
+ `response_model`, converting any data as necessary to generate the
+ corresponding JSON. But if the data in the object returned is not
+ valid, that would mean a violation of the contract with the client,
+ so it's an error from the API developer. So, FastAPI will raise an
+ error and return a 500 error code (Internal Server Error).
+
+ Read more about it in the
+ [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).
+ """
+ ),
+ ] = Default(None),
+ status_code: Annotated[
+ Optional[int],
+ Doc(
+ """
+ The default status code to be used for the response.
+
+ You could override the status code by returning a response directly.
+
+ Read more about it in the
+ [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).
+ """
+ ),
+ ] = None,
+ tags: Annotated[
+ Optional[List[Union[str, Enum]]],
+ Doc(
+ """
+ A list of tags to be applied to the *path operation*.
+
+ It will be added to the generated OpenAPI (e.g. visible at `/docs`).
+
+ Read more about it in the
+ [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).
+ """
+ ),
+ ] = None,
+ dependencies: Annotated[
+ Optional[Sequence[Depends]],
+ Doc(
+ """
+ A list of dependencies (using `Depends()`) to be applied to the
+ *path operation*.
+
+ Read more about it in the
+ [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).
+ """
+ ),
+ ] = None,
+ summary: Annotated[
+ Optional[str],
+ Doc(
+ """
+ A summary for the *path operation*.
+
+ It will be added to the generated OpenAPI (e.g. visible at `/docs`).
+
+ Read more about it in the
+ [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).
+ """
+ ),
+ ] = None,
+ description: Annotated[
+ Optional[str],
+ Doc(
+ """
+ A description for the *path operation*.
+
+ If not provided, it will be extracted automatically from the docstring
+ of the *path operation function*.
+
+ It can contain Markdown.
+
+ It will be added to the generated OpenAPI (e.g. visible at `/docs`).
+
+ Read more about it in the
+ [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).
+ """
+ ),
+ ] = None,
+ response_description: Annotated[
+ str,
+ Doc(
+ """
+ The description for the default response.
+
+ It will be added to the generated OpenAPI (e.g. visible at `/docs`).
+ """
+ ),
+ ] = "Successful Response",
+ responses: Annotated[
+ Optional[Dict[Union[int, str], Dict[str, Any]]],
+ Doc(
+ """
+ Additional responses that could be returned by this *path operation*.
+
+ It will be added to the generated OpenAPI (e.g. visible at `/docs`).
+ """
+ ),
+ ] = None,
+ deprecated: Annotated[
+ Optional[bool],
+ Doc(
+ """
+ Mark this *path operation* as deprecated.
+
+ It will be added to the generated OpenAPI (e.g. visible at `/docs`).
+ """
+ ),
+ ] = None,
+ operation_id: Annotated[
+ Optional[str],
+ Doc(
+ """
+ Custom operation ID to be used by this *path operation*.
+
+ By default, it is generated automatically.
+
+ If you provide a custom operation ID, you need to make sure it is
+ unique for the whole API.
+
+ You can customize the
+ operation ID generation with the parameter
+ `generate_unique_id_function` in the `FastAPI` class.
+
+ Read more about it in the
+ [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).
+ """
+ ),
+ ] = None,
+ response_model_include: Annotated[
+ Optional[IncEx],
+ Doc(
+ """
+ Configuration passed to Pydantic to include only certain fields in the
+ response data.
+
+ Read more about it in the
+ [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).
+ """
+ ),
+ ] = None,
+ response_model_exclude: Annotated[
+ Optional[IncEx],
+ Doc(
+ """
+ Configuration passed to Pydantic to exclude certain fields in the
+ response data.
+
+ Read more about it in the
+ [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).
+ """
+ ),
+ ] = None,
+ response_model_by_alias: Annotated[
+ bool,
+ Doc(
+ """
+ Configuration passed to Pydantic to define if the response model
+ should be serialized by alias when an alias is used.
+
+ Read more about it in the
+ [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).
+ """
+ ),
+ ] = True,
+ response_model_exclude_unset: Annotated[
+ bool,
+ Doc(
+ """
+ Configuration passed to Pydantic to define if the response data
+ should have all the fields, including the ones that were not set and
+ have their default values. This is different from
+ `response_model_exclude_defaults` in that if the fields are set,
+ they will be included in the response, even if the value is the same
+ as the default.
+
+ When `True`, default values are omitted from the response.
+
+ Read more about it in the
+ [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).
+ """
+ ),
+ ] = False,
+ response_model_exclude_defaults: Annotated[
+ bool,
+ Doc(
+ """
+ Configuration passed to Pydantic to define if the response data
+ should have all the fields, including the ones that have the same value
+ as the default. This is different from `response_model_exclude_unset`
+ in that if the fields are set but contain the same default values,
+ they will be excluded from the response.
+
+ When `True`, default values are omitted from the response.
+
+ Read more about it in the
+ [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).
+ """
+ ),
+ ] = False,
+ response_model_exclude_none: Annotated[
+ bool,
+ Doc(
+ """
+ Configuration passed to Pydantic to define if the response data should
+ exclude fields set to `None`.
+
+ This is much simpler (less smart) than `response_model_exclude_unset`
+ and `response_model_exclude_defaults`. You probably want to use one of
+ those two instead of this one, as those allow returning `None` values
+ when it makes sense.
+
+ Read more about it in the
+ [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).
+ """
+ ),
+ ] = False,
+ include_in_schema: Annotated[
+ bool,
+ Doc(
+ """
+ Include this *path operation* in the generated OpenAPI schema.
+
+ This affects the generated OpenAPI (e.g. visible at `/docs`).
+
+ Read more about it in the
+ [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).
+ """
+ ),
+ ] = True,
+ response_class: Annotated[
+ Type[Response],
+ Doc(
+ """
+ Response class to be used for this *path operation*.
+
+ This will not be used if you return a response directly.
+
+ Read more about it in the
+ [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).
+ """
+ ),
+ ] = Default(JSONResponse),
+ name: Annotated[
+ Optional[str],
+ Doc(
+ """
+ Name for this *path operation*. Only used internally.
+ """
+ ),
+ ] = None,
+ callbacks: Annotated[
+ Optional[List[BaseRoute]],
+ Doc(
+ """
+ List of *path operations* that will be used as OpenAPI callbacks.
+
+ This is only for OpenAPI documentation, the callbacks won't be used
+ directly.
+
+ It will be added to the generated OpenAPI (e.g. visible at `/docs`).
+
+ Read more about it in the
+ [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).
+ """
+ ),
+ ] = None,
+ openapi_extra: Annotated[
+ Optional[Dict[str, Any]],
+ Doc(
+ """
+ Extra metadata to be included in the OpenAPI schema for this *path
+ operation*.
+
+ Read more about it in the
+ [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).
+ """
+ ),
+ ] = None,
+ generate_unique_id_function: Annotated[
+ Callable[[routing.APIRoute], str],
+ Doc(
+ """
+ Customize the function used to generate unique IDs for the *path
+ operations* shown in the generated OpenAPI.
+
+ This is particularly useful when automatically generating clients or
+ SDKs for your API.
+
+ Read more about it in the
+ [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).
+ """
+ ),
+ ] = Default(generate_unique_id),
) -> Callable[[DecoratedCallable], DecoratedCallable]:
+ """
+ Add a *path operation* using an HTTP DELETE operation.
+
+ ## Example
+
+ ```python
+ from fastapi import FastAPI
+
+ app = FastAPI()
+
+ @app.delete("/items/{item_id}")
+ def delete_item(item_id: str):
+ return {"message": "Item deleted"}
+ ```
+ """
return self.router.delete(
path,
response_model=response_model,
@@ -691,33 +3015,351 @@ class FastAPI(Starlette):
def options(
self,
- path: str,
+ path: Annotated[
+ str,
+ Doc(
+ """
+ The URL path to be used for this *path operation*.
+
+ For example, in `http://example.com/items`, the path is `/items`.
+ """
+ ),
+ ],
*,
- response_model: Any = Default(None),
- status_code: Optional[int] = None,
- tags: Optional[List[Union[str, Enum]]] = None,
- dependencies: Optional[Sequence[Depends]] = None,
- summary: Optional[str] = None,
- description: Optional[str] = None,
- response_description: str = "Successful Response",
- responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,
- deprecated: Optional[bool] = None,
- operation_id: Optional[str] = None,
- response_model_include: Optional[IncEx] = None,
- response_model_exclude: Optional[IncEx] = None,
- response_model_by_alias: bool = True,
- response_model_exclude_unset: bool = False,
- response_model_exclude_defaults: bool = False,
- response_model_exclude_none: bool = False,
- include_in_schema: bool = True,
- response_class: Type[Response] = Default(JSONResponse),
- name: Optional[str] = None,
- callbacks: Optional[List[BaseRoute]] = None,
- openapi_extra: Optional[Dict[str, Any]] = None,
- generate_unique_id_function: Callable[[routing.APIRoute], str] = Default(
- generate_unique_id
- ),
+ response_model: Annotated[
+ Any,
+ Doc(
+ """
+ The type to use for the response.
+
+ It could be any valid Pydantic *field* type. So, it doesn't have to
+ be a Pydantic model, it could be other things, like a `list`, `dict`,
+ etc.
+
+ It will be used for:
+
+ * Documentation: the generated OpenAPI (and the UI at `/docs`) will
+ show it as the response (JSON Schema).
+ * Serialization: you could return an arbitrary object and the
+ `response_model` would be used to serialize that object into the
+ corresponding JSON.
+ * Filtering: the JSON sent to the client will only contain the data
+ (fields) defined in the `response_model`. If you returned an object
+ that contains an attribute `password` but the `response_model` does
+ not include that field, the JSON sent to the client would not have
+ that `password`.
+ * Validation: whatever you return will be serialized with the
+ `response_model`, converting any data as necessary to generate the
+ corresponding JSON. But if the data in the object returned is not
+ valid, that would mean a violation of the contract with the client,
+ so it's an error from the API developer. So, FastAPI will raise an
+ error and return a 500 error code (Internal Server Error).
+
+ Read more about it in the
+ [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).
+ """
+ ),
+ ] = Default(None),
+ status_code: Annotated[
+ Optional[int],
+ Doc(
+ """
+ The default status code to be used for the response.
+
+ You could override the status code by returning a response directly.
+
+ Read more about it in the
+ [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).
+ """
+ ),
+ ] = None,
+ tags: Annotated[
+ Optional[List[Union[str, Enum]]],
+ Doc(
+ """
+ A list of tags to be applied to the *path operation*.
+
+ It will be added to the generated OpenAPI (e.g. visible at `/docs`).
+
+ Read more about it in the
+ [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).
+ """
+ ),
+ ] = None,
+ dependencies: Annotated[
+ Optional[Sequence[Depends]],
+ Doc(
+ """
+ A list of dependencies (using `Depends()`) to be applied to the
+ *path operation*.
+
+ Read more about it in the
+ [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).
+ """
+ ),
+ ] = None,
+ summary: Annotated[
+ Optional[str],
+ Doc(
+ """
+ A summary for the *path operation*.
+
+ It will be added to the generated OpenAPI (e.g. visible at `/docs`).
+
+ Read more about it in the
+ [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).
+ """
+ ),
+ ] = None,
+ description: Annotated[
+ Optional[str],
+ Doc(
+ """
+ A description for the *path operation*.
+
+ If not provided, it will be extracted automatically from the docstring
+ of the *path operation function*.
+
+ It can contain Markdown.
+
+ It will be added to the generated OpenAPI (e.g. visible at `/docs`).
+
+ Read more about it in the
+ [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).
+ """
+ ),
+ ] = None,
+ response_description: Annotated[
+ str,
+ Doc(
+ """
+ The description for the default response.
+
+ It will be added to the generated OpenAPI (e.g. visible at `/docs`).
+ """
+ ),
+ ] = "Successful Response",
+ responses: Annotated[
+ Optional[Dict[Union[int, str], Dict[str, Any]]],
+ Doc(
+ """
+ Additional responses that could be returned by this *path operation*.
+
+ It will be added to the generated OpenAPI (e.g. visible at `/docs`).
+ """
+ ),
+ ] = None,
+ deprecated: Annotated[
+ Optional[bool],
+ Doc(
+ """
+ Mark this *path operation* as deprecated.
+
+ It will be added to the generated OpenAPI (e.g. visible at `/docs`).
+ """
+ ),
+ ] = None,
+ operation_id: Annotated[
+ Optional[str],
+ Doc(
+ """
+ Custom operation ID to be used by this *path operation*.
+
+ By default, it is generated automatically.
+
+ If you provide a custom operation ID, you need to make sure it is
+ unique for the whole API.
+
+ You can customize the
+ operation ID generation with the parameter
+ `generate_unique_id_function` in the `FastAPI` class.
+
+ Read more about it in the
+ [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).
+ """
+ ),
+ ] = None,
+ response_model_include: Annotated[
+ Optional[IncEx],
+ Doc(
+ """
+ Configuration passed to Pydantic to include only certain fields in the
+ response data.
+
+ Read more about it in the
+ [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).
+ """
+ ),
+ ] = None,
+ response_model_exclude: Annotated[
+ Optional[IncEx],
+ Doc(
+ """
+ Configuration passed to Pydantic to exclude certain fields in the
+ response data.
+
+ Read more about it in the
+ [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).
+ """
+ ),
+ ] = None,
+ response_model_by_alias: Annotated[
+ bool,
+ Doc(
+ """
+ Configuration passed to Pydantic to define if the response model
+ should be serialized by alias when an alias is used.
+
+ Read more about it in the
+ [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).
+ """
+ ),
+ ] = True,
+ response_model_exclude_unset: Annotated[
+ bool,
+ Doc(
+ """
+ Configuration passed to Pydantic to define if the response data
+ should have all the fields, including the ones that were not set and
+ have their default values. This is different from
+ `response_model_exclude_defaults` in that if the fields are set,
+ they will be included in the response, even if the value is the same
+ as the default.
+
+ When `True`, default values are omitted from the response.
+
+ Read more about it in the
+ [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).
+ """
+ ),
+ ] = False,
+ response_model_exclude_defaults: Annotated[
+ bool,
+ Doc(
+ """
+ Configuration passed to Pydantic to define if the response data
+ should have all the fields, including the ones that have the same value
+ as the default. This is different from `response_model_exclude_unset`
+ in that if the fields are set but contain the same default values,
+ they will be excluded from the response.
+
+ When `True`, default values are omitted from the response.
+
+ Read more about it in the
+ [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).
+ """
+ ),
+ ] = False,
+ response_model_exclude_none: Annotated[
+ bool,
+ Doc(
+ """
+ Configuration passed to Pydantic to define if the response data should
+ exclude fields set to `None`.
+
+ This is much simpler (less smart) than `response_model_exclude_unset`
+ and `response_model_exclude_defaults`. You probably want to use one of
+ those two instead of this one, as those allow returning `None` values
+ when it makes sense.
+
+ Read more about it in the
+ [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).
+ """
+ ),
+ ] = False,
+ include_in_schema: Annotated[
+ bool,
+ Doc(
+ """
+ Include this *path operation* in the generated OpenAPI schema.
+
+ This affects the generated OpenAPI (e.g. visible at `/docs`).
+
+ Read more about it in the
+ [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).
+ """
+ ),
+ ] = True,
+ response_class: Annotated[
+ Type[Response],
+ Doc(
+ """
+ Response class to be used for this *path operation*.
+
+ This will not be used if you return a response directly.
+
+ Read more about it in the
+ [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).
+ """
+ ),
+ ] = Default(JSONResponse),
+ name: Annotated[
+ Optional[str],
+ Doc(
+ """
+ Name for this *path operation*. Only used internally.
+ """
+ ),
+ ] = None,
+ callbacks: Annotated[
+ Optional[List[BaseRoute]],
+ Doc(
+ """
+ List of *path operations* that will be used as OpenAPI callbacks.
+
+ This is only for OpenAPI documentation, the callbacks won't be used
+ directly.
+
+ It will be added to the generated OpenAPI (e.g. visible at `/docs`).
+
+ Read more about it in the
+ [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).
+ """
+ ),
+ ] = None,
+ openapi_extra: Annotated[
+ Optional[Dict[str, Any]],
+ Doc(
+ """
+ Extra metadata to be included in the OpenAPI schema for this *path
+ operation*.
+
+ Read more about it in the
+ [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).
+ """
+ ),
+ ] = None,
+ generate_unique_id_function: Annotated[
+ Callable[[routing.APIRoute], str],
+ Doc(
+ """
+ Customize the function used to generate unique IDs for the *path
+ operations* shown in the generated OpenAPI.
+
+ This is particularly useful when automatically generating clients or
+ SDKs for your API.
+
+ Read more about it in the
+ [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).
+ """
+ ),
+ ] = Default(generate_unique_id),
) -> Callable[[DecoratedCallable], DecoratedCallable]:
+ """
+ Add a *path operation* using an HTTP OPTIONS operation.
+
+ ## Example
+
+ ```python
+ from fastapi import FastAPI
+
+ app = FastAPI()
+
+ @app.options("/items/")
+ def get_item_options():
+ return {"additions": ["Aji", "Guacamole"]}
+ ```
+ """
return self.router.options(
path,
response_model=response_model,
@@ -746,33 +3388,351 @@ class FastAPI(Starlette):
def head(
self,
- path: str,
+ path: Annotated[
+ str,
+ Doc(
+ """
+ The URL path to be used for this *path operation*.
+
+ For example, in `http://example.com/items`, the path is `/items`.
+ """
+ ),
+ ],
*,
- response_model: Any = Default(None),
- status_code: Optional[int] = None,
- tags: Optional[List[Union[str, Enum]]] = None,
- dependencies: Optional[Sequence[Depends]] = None,
- summary: Optional[str] = None,
- description: Optional[str] = None,
- response_description: str = "Successful Response",
- responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,
- deprecated: Optional[bool] = None,
- operation_id: Optional[str] = None,
- response_model_include: Optional[IncEx] = None,
- response_model_exclude: Optional[IncEx] = None,
- response_model_by_alias: bool = True,
- response_model_exclude_unset: bool = False,
- response_model_exclude_defaults: bool = False,
- response_model_exclude_none: bool = False,
- include_in_schema: bool = True,
- response_class: Type[Response] = Default(JSONResponse),
- name: Optional[str] = None,
- callbacks: Optional[List[BaseRoute]] = None,
- openapi_extra: Optional[Dict[str, Any]] = None,
- generate_unique_id_function: Callable[[routing.APIRoute], str] = Default(
- generate_unique_id
- ),
+ response_model: Annotated[
+ Any,
+ Doc(
+ """
+ The type to use for the response.
+
+ It could be any valid Pydantic *field* type. So, it doesn't have to
+ be a Pydantic model, it could be other things, like a `list`, `dict`,
+ etc.
+
+ It will be used for:
+
+ * Documentation: the generated OpenAPI (and the UI at `/docs`) will
+ show it as the response (JSON Schema).
+ * Serialization: you could return an arbitrary object and the
+ `response_model` would be used to serialize that object into the
+ corresponding JSON.
+ * Filtering: the JSON sent to the client will only contain the data
+ (fields) defined in the `response_model`. If you returned an object
+ that contains an attribute `password` but the `response_model` does
+ not include that field, the JSON sent to the client would not have
+ that `password`.
+ * Validation: whatever you return will be serialized with the
+ `response_model`, converting any data as necessary to generate the
+ corresponding JSON. But if the data in the object returned is not
+ valid, that would mean a violation of the contract with the client,
+ so it's an error from the API developer. So, FastAPI will raise an
+ error and return a 500 error code (Internal Server Error).
+
+ Read more about it in the
+ [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).
+ """
+ ),
+ ] = Default(None),
+ status_code: Annotated[
+ Optional[int],
+ Doc(
+ """
+ The default status code to be used for the response.
+
+ You could override the status code by returning a response directly.
+
+ Read more about it in the
+ [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).
+ """
+ ),
+ ] = None,
+ tags: Annotated[
+ Optional[List[Union[str, Enum]]],
+ Doc(
+ """
+ A list of tags to be applied to the *path operation*.
+
+ It will be added to the generated OpenAPI (e.g. visible at `/docs`).
+
+ Read more about it in the
+ [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).
+ """
+ ),
+ ] = None,
+ dependencies: Annotated[
+ Optional[Sequence[Depends]],
+ Doc(
+ """
+ A list of dependencies (using `Depends()`) to be applied to the
+ *path operation*.
+
+ Read more about it in the
+ [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).
+ """
+ ),
+ ] = None,
+ summary: Annotated[
+ Optional[str],
+ Doc(
+ """
+ A summary for the *path operation*.
+
+ It will be added to the generated OpenAPI (e.g. visible at `/docs`).
+
+ Read more about it in the
+ [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).
+ """
+ ),
+ ] = None,
+ description: Annotated[
+ Optional[str],
+ Doc(
+ """
+ A description for the *path operation*.
+
+ If not provided, it will be extracted automatically from the docstring
+ of the *path operation function*.
+
+ It can contain Markdown.
+
+ It will be added to the generated OpenAPI (e.g. visible at `/docs`).
+
+ Read more about it in the
+ [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).
+ """
+ ),
+ ] = None,
+ response_description: Annotated[
+ str,
+ Doc(
+ """
+ The description for the default response.
+
+ It will be added to the generated OpenAPI (e.g. visible at `/docs`).
+ """
+ ),
+ ] = "Successful Response",
+ responses: Annotated[
+ Optional[Dict[Union[int, str], Dict[str, Any]]],
+ Doc(
+ """
+ Additional responses that could be returned by this *path operation*.
+
+ It will be added to the generated OpenAPI (e.g. visible at `/docs`).
+ """
+ ),
+ ] = None,
+ deprecated: Annotated[
+ Optional[bool],
+ Doc(
+ """
+ Mark this *path operation* as deprecated.
+
+ It will be added to the generated OpenAPI (e.g. visible at `/docs`).
+ """
+ ),
+ ] = None,
+ operation_id: Annotated[
+ Optional[str],
+ Doc(
+ """
+ Custom operation ID to be used by this *path operation*.
+
+ By default, it is generated automatically.
+
+ If you provide a custom operation ID, you need to make sure it is
+ unique for the whole API.
+
+ You can customize the
+ operation ID generation with the parameter
+ `generate_unique_id_function` in the `FastAPI` class.
+
+ Read more about it in the
+ [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).
+ """
+ ),
+ ] = None,
+ response_model_include: Annotated[
+ Optional[IncEx],
+ Doc(
+ """
+ Configuration passed to Pydantic to include only certain fields in the
+ response data.
+
+ Read more about it in the
+ [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).
+ """
+ ),
+ ] = None,
+ response_model_exclude: Annotated[
+ Optional[IncEx],
+ Doc(
+ """
+ Configuration passed to Pydantic to exclude certain fields in the
+ response data.
+
+ Read more about it in the
+ [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).
+ """
+ ),
+ ] = None,
+ response_model_by_alias: Annotated[
+ bool,
+ Doc(
+ """
+ Configuration passed to Pydantic to define if the response model
+ should be serialized by alias when an alias is used.
+
+ Read more about it in the
+ [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).
+ """
+ ),
+ ] = True,
+ response_model_exclude_unset: Annotated[
+ bool,
+ Doc(
+ """
+ Configuration passed to Pydantic to define if the response data
+ should have all the fields, including the ones that were not set and
+ have their default values. This is different from
+ `response_model_exclude_defaults` in that if the fields are set,
+ they will be included in the response, even if the value is the same
+ as the default.
+
+ When `True`, default values are omitted from the response.
+
+ Read more about it in the
+ [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).
+ """
+ ),
+ ] = False,
+ response_model_exclude_defaults: Annotated[
+ bool,
+ Doc(
+ """
+ Configuration passed to Pydantic to define if the response data
+ should have all the fields, including the ones that have the same value
+ as the default. This is different from `response_model_exclude_unset`
+ in that if the fields are set but contain the same default values,
+ they will be excluded from the response.
+
+ When `True`, default values are omitted from the response.
+
+ Read more about it in the
+ [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).
+ """
+ ),
+ ] = False,
+ response_model_exclude_none: Annotated[
+ bool,
+ Doc(
+ """
+ Configuration passed to Pydantic to define if the response data should
+ exclude fields set to `None`.
+
+ This is much simpler (less smart) than `response_model_exclude_unset`
+ and `response_model_exclude_defaults`. You probably want to use one of
+ those two instead of this one, as those allow returning `None` values
+ when it makes sense.
+
+ Read more about it in the
+ [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).
+ """
+ ),
+ ] = False,
+ include_in_schema: Annotated[
+ bool,
+ Doc(
+ """
+ Include this *path operation* in the generated OpenAPI schema.
+
+ This affects the generated OpenAPI (e.g. visible at `/docs`).
+
+ Read more about it in the
+ [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).
+ """
+ ),
+ ] = True,
+ response_class: Annotated[
+ Type[Response],
+ Doc(
+ """
+ Response class to be used for this *path operation*.
+
+ This will not be used if you return a response directly.
+
+ Read more about it in the
+ [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).
+ """
+ ),
+ ] = Default(JSONResponse),
+ name: Annotated[
+ Optional[str],
+ Doc(
+ """
+ Name for this *path operation*. Only used internally.
+ """
+ ),
+ ] = None,
+ callbacks: Annotated[
+ Optional[List[BaseRoute]],
+ Doc(
+ """
+ List of *path operations* that will be used as OpenAPI callbacks.
+
+ This is only for OpenAPI documentation, the callbacks won't be used
+ directly.
+
+ It will be added to the generated OpenAPI (e.g. visible at `/docs`).
+
+ Read more about it in the
+ [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).
+ """
+ ),
+ ] = None,
+ openapi_extra: Annotated[
+ Optional[Dict[str, Any]],
+ Doc(
+ """
+ Extra metadata to be included in the OpenAPI schema for this *path
+ operation*.
+
+ Read more about it in the
+ [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).
+ """
+ ),
+ ] = None,
+ generate_unique_id_function: Annotated[
+ Callable[[routing.APIRoute], str],
+ Doc(
+ """
+ Customize the function used to generate unique IDs for the *path
+ operations* shown in the generated OpenAPI.
+
+ This is particularly useful when automatically generating clients or
+ SDKs for your API.
+
+ Read more about it in the
+ [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).
+ """
+ ),
+ ] = Default(generate_unique_id),
) -> Callable[[DecoratedCallable], DecoratedCallable]:
+ """
+ Add a *path operation* using an HTTP HEAD operation.
+
+ ## Example
+
+ ```python
+ from fastapi import FastAPI, Response
+
+ app = FastAPI()
+
+ @app.head("/items/", status_code=204)
+ def get_items_headers(response: Response):
+ response.headers["X-Cat-Dog"] = "Alone in the world"
+ ```
+ """
return self.router.head(
path,
response_model=response_model,
@@ -801,33 +3761,356 @@ class FastAPI(Starlette):
def patch(
self,
- path: str,
+ path: Annotated[
+ str,
+ Doc(
+ """
+ The URL path to be used for this *path operation*.
+
+ For example, in `http://example.com/items`, the path is `/items`.
+ """
+ ),
+ ],
*,
- response_model: Any = Default(None),
- status_code: Optional[int] = None,
- tags: Optional[List[Union[str, Enum]]] = None,
- dependencies: Optional[Sequence[Depends]] = None,
- summary: Optional[str] = None,
- description: Optional[str] = None,
- response_description: str = "Successful Response",
- responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,
- deprecated: Optional[bool] = None,
- operation_id: Optional[str] = None,
- response_model_include: Optional[IncEx] = None,
- response_model_exclude: Optional[IncEx] = None,
- response_model_by_alias: bool = True,
- response_model_exclude_unset: bool = False,
- response_model_exclude_defaults: bool = False,
- response_model_exclude_none: bool = False,
- include_in_schema: bool = True,
- response_class: Type[Response] = Default(JSONResponse),
- name: Optional[str] = None,
- callbacks: Optional[List[BaseRoute]] = None,
- openapi_extra: Optional[Dict[str, Any]] = None,
- generate_unique_id_function: Callable[[routing.APIRoute], str] = Default(
- generate_unique_id
- ),
+ response_model: Annotated[
+ Any,
+ Doc(
+ """
+ The type to use for the response.
+
+ It could be any valid Pydantic *field* type. So, it doesn't have to
+ be a Pydantic model, it could be other things, like a `list`, `dict`,
+ etc.
+
+ It will be used for:
+
+ * Documentation: the generated OpenAPI (and the UI at `/docs`) will
+ show it as the response (JSON Schema).
+ * Serialization: you could return an arbitrary object and the
+ `response_model` would be used to serialize that object into the
+ corresponding JSON.
+ * Filtering: the JSON sent to the client will only contain the data
+ (fields) defined in the `response_model`. If you returned an object
+ that contains an attribute `password` but the `response_model` does
+ not include that field, the JSON sent to the client would not have
+ that `password`.
+ * Validation: whatever you return will be serialized with the
+ `response_model`, converting any data as necessary to generate the
+ corresponding JSON. But if the data in the object returned is not
+ valid, that would mean a violation of the contract with the client,
+ so it's an error from the API developer. So, FastAPI will raise an
+ error and return a 500 error code (Internal Server Error).
+
+ Read more about it in the
+ [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).
+ """
+ ),
+ ] = Default(None),
+ status_code: Annotated[
+ Optional[int],
+ Doc(
+ """
+ The default status code to be used for the response.
+
+ You could override the status code by returning a response directly.
+
+ Read more about it in the
+ [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).
+ """
+ ),
+ ] = None,
+ tags: Annotated[
+ Optional[List[Union[str, Enum]]],
+ Doc(
+ """
+ A list of tags to be applied to the *path operation*.
+
+ It will be added to the generated OpenAPI (e.g. visible at `/docs`).
+
+ Read more about it in the
+ [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).
+ """
+ ),
+ ] = None,
+ dependencies: Annotated[
+ Optional[Sequence[Depends]],
+ Doc(
+ """
+ A list of dependencies (using `Depends()`) to be applied to the
+ *path operation*.
+
+ Read more about it in the
+ [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).
+ """
+ ),
+ ] = None,
+ summary: Annotated[
+ Optional[str],
+ Doc(
+ """
+ A summary for the *path operation*.
+
+ It will be added to the generated OpenAPI (e.g. visible at `/docs`).
+
+ Read more about it in the
+ [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).
+ """
+ ),
+ ] = None,
+ description: Annotated[
+ Optional[str],
+ Doc(
+ """
+ A description for the *path operation*.
+
+ If not provided, it will be extracted automatically from the docstring
+ of the *path operation function*.
+
+ It can contain Markdown.
+
+ It will be added to the generated OpenAPI (e.g. visible at `/docs`).
+
+ Read more about it in the
+ [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).
+ """
+ ),
+ ] = None,
+ response_description: Annotated[
+ str,
+ Doc(
+ """
+ The description for the default response.
+
+ It will be added to the generated OpenAPI (e.g. visible at `/docs`).
+ """
+ ),
+ ] = "Successful Response",
+ responses: Annotated[
+ Optional[Dict[Union[int, str], Dict[str, Any]]],
+ Doc(
+ """
+ Additional responses that could be returned by this *path operation*.
+
+ It will be added to the generated OpenAPI (e.g. visible at `/docs`).
+ """
+ ),
+ ] = None,
+ deprecated: Annotated[
+ Optional[bool],
+ Doc(
+ """
+ Mark this *path operation* as deprecated.
+
+ It will be added to the generated OpenAPI (e.g. visible at `/docs`).
+ """
+ ),
+ ] = None,
+ operation_id: Annotated[
+ Optional[str],
+ Doc(
+ """
+ Custom operation ID to be used by this *path operation*.
+
+ By default, it is generated automatically.
+
+ If you provide a custom operation ID, you need to make sure it is
+ unique for the whole API.
+
+ You can customize the
+ operation ID generation with the parameter
+ `generate_unique_id_function` in the `FastAPI` class.
+
+ Read more about it in the
+ [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).
+ """
+ ),
+ ] = None,
+ response_model_include: Annotated[
+ Optional[IncEx],
+ Doc(
+ """
+ Configuration passed to Pydantic to include only certain fields in the
+ response data.
+
+ Read more about it in the
+ [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).
+ """
+ ),
+ ] = None,
+ response_model_exclude: Annotated[
+ Optional[IncEx],
+ Doc(
+ """
+ Configuration passed to Pydantic to exclude certain fields in the
+ response data.
+
+ Read more about it in the
+ [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).
+ """
+ ),
+ ] = None,
+ response_model_by_alias: Annotated[
+ bool,
+ Doc(
+ """
+ Configuration passed to Pydantic to define if the response model
+ should be serialized by alias when an alias is used.
+
+ Read more about it in the
+ [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).
+ """
+ ),
+ ] = True,
+ response_model_exclude_unset: Annotated[
+ bool,
+ Doc(
+ """
+ Configuration passed to Pydantic to define if the response data
+ should have all the fields, including the ones that were not set and
+ have their default values. This is different from
+ `response_model_exclude_defaults` in that if the fields are set,
+ they will be included in the response, even if the value is the same
+ as the default.
+
+ When `True`, default values are omitted from the response.
+
+ Read more about it in the
+ [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).
+ """
+ ),
+ ] = False,
+ response_model_exclude_defaults: Annotated[
+ bool,
+ Doc(
+ """
+ Configuration passed to Pydantic to define if the response data
+ should have all the fields, including the ones that have the same value
+ as the default. This is different from `response_model_exclude_unset`
+ in that if the fields are set but contain the same default values,
+ they will be excluded from the response.
+
+ When `True`, default values are omitted from the response.
+
+ Read more about it in the
+ [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).
+ """
+ ),
+ ] = False,
+ response_model_exclude_none: Annotated[
+ bool,
+ Doc(
+ """
+ Configuration passed to Pydantic to define if the response data should
+ exclude fields set to `None`.
+
+ This is much simpler (less smart) than `response_model_exclude_unset`
+ and `response_model_exclude_defaults`. You probably want to use one of
+ those two instead of this one, as those allow returning `None` values
+ when it makes sense.
+
+ Read more about it in the
+ [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).
+ """
+ ),
+ ] = False,
+ include_in_schema: Annotated[
+ bool,
+ Doc(
+ """
+ Include this *path operation* in the generated OpenAPI schema.
+
+ This affects the generated OpenAPI (e.g. visible at `/docs`).
+
+ Read more about it in the
+ [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).
+ """
+ ),
+ ] = True,
+ response_class: Annotated[
+ Type[Response],
+ Doc(
+ """
+ Response class to be used for this *path operation*.
+
+ This will not be used if you return a response directly.
+
+ Read more about it in the
+ [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).
+ """
+ ),
+ ] = Default(JSONResponse),
+ name: Annotated[
+ Optional[str],
+ Doc(
+ """
+ Name for this *path operation*. Only used internally.
+ """
+ ),
+ ] = None,
+ callbacks: Annotated[
+ Optional[List[BaseRoute]],
+ Doc(
+ """
+ List of *path operations* that will be used as OpenAPI callbacks.
+
+ This is only for OpenAPI documentation, the callbacks won't be used
+ directly.
+
+ It will be added to the generated OpenAPI (e.g. visible at `/docs`).
+
+ Read more about it in the
+ [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).
+ """
+ ),
+ ] = None,
+ openapi_extra: Annotated[
+ Optional[Dict[str, Any]],
+ Doc(
+ """
+ Extra metadata to be included in the OpenAPI schema for this *path
+ operation*.
+
+ Read more about it in the
+ [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).
+ """
+ ),
+ ] = None,
+ generate_unique_id_function: Annotated[
+ Callable[[routing.APIRoute], str],
+ Doc(
+ """
+ Customize the function used to generate unique IDs for the *path
+ operations* shown in the generated OpenAPI.
+
+ This is particularly useful when automatically generating clients or
+ SDKs for your API.
+
+ Read more about it in the
+ [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).
+ """
+ ),
+ ] = Default(generate_unique_id),
) -> Callable[[DecoratedCallable], DecoratedCallable]:
+ """
+ Add a *path operation* using an HTTP PATCH operation.
+
+ ## Example
+
+ ```python
+ from fastapi import FastAPI
+ from pydantic import BaseModel
+
+ class Item(BaseModel):
+ name: str
+ description: str | None = None
+
+ app = FastAPI()
+
+ @app.patch("/items/")
+ def update_item(item: Item):
+ return {"message": "Item updated in place"}
+ ```
+ """
return self.router.patch(
path,
response_model=response_model,
@@ -856,33 +4139,351 @@ class FastAPI(Starlette):
def trace(
self,
- path: str,
+ path: Annotated[
+ str,
+ Doc(
+ """
+ The URL path to be used for this *path operation*.
+
+ For example, in `http://example.com/items`, the path is `/items`.
+ """
+ ),
+ ],
*,
- response_model: Any = Default(None),
- status_code: Optional[int] = None,
- tags: Optional[List[Union[str, Enum]]] = None,
- dependencies: Optional[Sequence[Depends]] = None,
- summary: Optional[str] = None,
- description: Optional[str] = None,
- response_description: str = "Successful Response",
- responses: Optional[Dict[Union[int, str], Dict[str, Any]]] = None,
- deprecated: Optional[bool] = None,
- operation_id: Optional[str] = None,
- response_model_include: Optional[IncEx] = None,
- response_model_exclude: Optional[IncEx] = None,
- response_model_by_alias: bool = True,
- response_model_exclude_unset: bool = False,
- response_model_exclude_defaults: bool = False,
- response_model_exclude_none: bool = False,
- include_in_schema: bool = True,
- response_class: Type[Response] = Default(JSONResponse),
- name: Optional[str] = None,
- callbacks: Optional[List[BaseRoute]] = None,
- openapi_extra: Optional[Dict[str, Any]] = None,
- generate_unique_id_function: Callable[[routing.APIRoute], str] = Default(
- generate_unique_id
- ),
+ response_model: Annotated[
+ Any,
+ Doc(
+ """
+ The type to use for the response.
+
+ It could be any valid Pydantic *field* type. So, it doesn't have to
+ be a Pydantic model, it could be other things, like a `list`, `dict`,
+ etc.
+
+ It will be used for:
+
+ * Documentation: the generated OpenAPI (and the UI at `/docs`) will
+ show it as the response (JSON Schema).
+ * Serialization: you could return an arbitrary object and the
+ `response_model` would be used to serialize that object into the
+ corresponding JSON.
+ * Filtering: the JSON sent to the client will only contain the data
+ (fields) defined in the `response_model`. If you returned an object
+ that contains an attribute `password` but the `response_model` does
+ not include that field, the JSON sent to the client would not have
+ that `password`.
+ * Validation: whatever you return will be serialized with the
+ `response_model`, converting any data as necessary to generate the
+ corresponding JSON. But if the data in the object returned is not
+ valid, that would mean a violation of the contract with the client,
+ so it's an error from the API developer. So, FastAPI will raise an
+ error and return a 500 error code (Internal Server Error).
+
+ Read more about it in the
+ [FastAPI docs for Response Model](https://fastapi.tiangolo.com/tutorial/response-model/).
+ """
+ ),
+ ] = Default(None),
+ status_code: Annotated[
+ Optional[int],
+ Doc(
+ """
+ The default status code to be used for the response.
+
+ You could override the status code by returning a response directly.
+
+ Read more about it in the
+ [FastAPI docs for Response Status Code](https://fastapi.tiangolo.com/tutorial/response-status-code/).
+ """
+ ),
+ ] = None,
+ tags: Annotated[
+ Optional[List[Union[str, Enum]]],
+ Doc(
+ """
+ A list of tags to be applied to the *path operation*.
+
+ It will be added to the generated OpenAPI (e.g. visible at `/docs`).
+
+ Read more about it in the
+ [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#tags).
+ """
+ ),
+ ] = None,
+ dependencies: Annotated[
+ Optional[Sequence[Depends]],
+ Doc(
+ """
+ A list of dependencies (using `Depends()`) to be applied to the
+ *path operation*.
+
+ Read more about it in the
+ [FastAPI docs for Dependencies in path operation decorators](https://fastapi.tiangolo.com/tutorial/dependencies/dependencies-in-path-operation-decorators/).
+ """
+ ),
+ ] = None,
+ summary: Annotated[
+ Optional[str],
+ Doc(
+ """
+ A summary for the *path operation*.
+
+ It will be added to the generated OpenAPI (e.g. visible at `/docs`).
+
+ Read more about it in the
+ [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).
+ """
+ ),
+ ] = None,
+ description: Annotated[
+ Optional[str],
+ Doc(
+ """
+ A description for the *path operation*.
+
+ If not provided, it will be extracted automatically from the docstring
+ of the *path operation function*.
+
+ It can contain Markdown.
+
+ It will be added to the generated OpenAPI (e.g. visible at `/docs`).
+
+ Read more about it in the
+ [FastAPI docs for Path Operation Configuration](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/).
+ """
+ ),
+ ] = None,
+ response_description: Annotated[
+ str,
+ Doc(
+ """
+ The description for the default response.
+
+ It will be added to the generated OpenAPI (e.g. visible at `/docs`).
+ """
+ ),
+ ] = "Successful Response",
+ responses: Annotated[
+ Optional[Dict[Union[int, str], Dict[str, Any]]],
+ Doc(
+ """
+ Additional responses that could be returned by this *path operation*.
+
+ It will be added to the generated OpenAPI (e.g. visible at `/docs`).
+ """
+ ),
+ ] = None,
+ deprecated: Annotated[
+ Optional[bool],
+ Doc(
+ """
+ Mark this *path operation* as deprecated.
+
+ It will be added to the generated OpenAPI (e.g. visible at `/docs`).
+ """
+ ),
+ ] = None,
+ operation_id: Annotated[
+ Optional[str],
+ Doc(
+ """
+ Custom operation ID to be used by this *path operation*.
+
+ By default, it is generated automatically.
+
+ If you provide a custom operation ID, you need to make sure it is
+ unique for the whole API.
+
+ You can customize the
+ operation ID generation with the parameter
+ `generate_unique_id_function` in the `FastAPI` class.
+
+ Read more about it in the
+ [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).
+ """
+ ),
+ ] = None,
+ response_model_include: Annotated[
+ Optional[IncEx],
+ Doc(
+ """
+ Configuration passed to Pydantic to include only certain fields in the
+ response data.
+
+ Read more about it in the
+ [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).
+ """
+ ),
+ ] = None,
+ response_model_exclude: Annotated[
+ Optional[IncEx],
+ Doc(
+ """
+ Configuration passed to Pydantic to exclude certain fields in the
+ response data.
+
+ Read more about it in the
+ [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).
+ """
+ ),
+ ] = None,
+ response_model_by_alias: Annotated[
+ bool,
+ Doc(
+ """
+ Configuration passed to Pydantic to define if the response model
+ should be serialized by alias when an alias is used.
+
+ Read more about it in the
+ [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_include-and-response_model_exclude).
+ """
+ ),
+ ] = True,
+ response_model_exclude_unset: Annotated[
+ bool,
+ Doc(
+ """
+ Configuration passed to Pydantic to define if the response data
+ should have all the fields, including the ones that were not set and
+ have their default values. This is different from
+ `response_model_exclude_defaults` in that if the fields are set,
+ they will be included in the response, even if the value is the same
+ as the default.
+
+ When `True`, default values are omitted from the response.
+
+ Read more about it in the
+ [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).
+ """
+ ),
+ ] = False,
+ response_model_exclude_defaults: Annotated[
+ bool,
+ Doc(
+ """
+ Configuration passed to Pydantic to define if the response data
+ should have all the fields, including the ones that have the same value
+ as the default. This is different from `response_model_exclude_unset`
+ in that if the fields are set but contain the same default values,
+ they will be excluded from the response.
+
+ When `True`, default values are omitted from the response.
+
+ Read more about it in the
+ [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#use-the-response_model_exclude_unset-parameter).
+ """
+ ),
+ ] = False,
+ response_model_exclude_none: Annotated[
+ bool,
+ Doc(
+ """
+ Configuration passed to Pydantic to define if the response data should
+ exclude fields set to `None`.
+
+ This is much simpler (less smart) than `response_model_exclude_unset`
+ and `response_model_exclude_defaults`. You probably want to use one of
+ those two instead of this one, as those allow returning `None` values
+ when it makes sense.
+
+ Read more about it in the
+ [FastAPI docs for Response Model - Return Type](https://fastapi.tiangolo.com/tutorial/response-model/#response_model_exclude_none).
+ """
+ ),
+ ] = False,
+ include_in_schema: Annotated[
+ bool,
+ Doc(
+ """
+ Include this *path operation* in the generated OpenAPI schema.
+
+ This affects the generated OpenAPI (e.g. visible at `/docs`).
+
+ Read more about it in the
+ [FastAPI docs for Query Parameters and String Validations](https://fastapi.tiangolo.com/tutorial/query-params-str-validations/#exclude-from-openapi).
+ """
+ ),
+ ] = True,
+ response_class: Annotated[
+ Type[Response],
+ Doc(
+ """
+ Response class to be used for this *path operation*.
+
+ This will not be used if you return a response directly.
+
+ Read more about it in the
+ [FastAPI docs for Custom Response - HTML, Stream, File, others](https://fastapi.tiangolo.com/advanced/custom-response/#redirectresponse).
+ """
+ ),
+ ] = Default(JSONResponse),
+ name: Annotated[
+ Optional[str],
+ Doc(
+ """
+ Name for this *path operation*. Only used internally.
+ """
+ ),
+ ] = None,
+ callbacks: Annotated[
+ Optional[List[BaseRoute]],
+ Doc(
+ """
+ List of *path operations* that will be used as OpenAPI callbacks.
+
+ This is only for OpenAPI documentation, the callbacks won't be used
+ directly.
+
+ It will be added to the generated OpenAPI (e.g. visible at `/docs`).
+
+ Read more about it in the
+ [FastAPI docs for OpenAPI Callbacks](https://fastapi.tiangolo.com/advanced/openapi-callbacks/).
+ """
+ ),
+ ] = None,
+ openapi_extra: Annotated[
+ Optional[Dict[str, Any]],
+ Doc(
+ """
+ Extra metadata to be included in the OpenAPI schema for this *path
+ operation*.
+
+ Read more about it in the
+ [FastAPI docs for Path Operation Advanced Configuration](https://fastapi.tiangolo.com/advanced/path-operation-advanced-configuration/#custom-openapi-path-operation-schema).
+ """
+ ),
+ ] = None,
+ generate_unique_id_function: Annotated[
+ Callable[[routing.APIRoute], str],
+ Doc(
+ """
+ Customize the function used to generate unique IDs for the *path
+ operations* shown in the generated OpenAPI.
+
+ This is particularly useful when automatically generating clients or
+ SDKs for your API.
+
+ Read more about it in the
+ [FastAPI docs about how to Generate Clients](https://fastapi.tiangolo.com/advanced/generate-clients/#custom-generate-unique-id-function).
+ """
+ ),
+ ] = Default(generate_unique_id),
) -> Callable[[DecoratedCallable], DecoratedCallable]:
+ """
+ Add a *path operation* using an HTTP TRACE operation.
+
+ ## Example
+
+ ```python
+ from fastapi import FastAPI
+
+ app = FastAPI()
+
+ @app.put("/items/{item_id}")
+ def trace_item(item_id: str):
+ return None
+ ```
+ """
return self.router.trace(
path,
response_model=response_model,
@@ -918,14 +4519,72 @@ class FastAPI(Starlette):
return decorator
+ @deprecated(
+ """
+ on_event is deprecated, use lifespan event handlers instead.
+
+ Read more about it in the
+ [FastAPI docs for Lifespan Events](https://fastapi.tiangolo.com/advanced/events/).
+ """
+ )
def on_event(
- self, event_type: str
+ self,
+ event_type: Annotated[
+ str,
+ Doc(
+ """
+ The type of event. `startup` or `shutdown`.
+ """
+ ),
+ ],
) -> Callable[[DecoratedCallable], DecoratedCallable]:
+ """
+ Add an event handler for the application.
+
+ `on_event` is deprecated, use `lifespan` event handlers instead.
+
+ Read more about it in the
+ [FastAPI docs for Lifespan Events](https://fastapi.tiangolo.com/advanced/events/#alternative-events-deprecated).
+ """
return self.router.on_event(event_type)
def middleware(
- self, middleware_type: str
+ self,
+ middleware_type: Annotated[
+ str,
+ Doc(
+ """
+ The type of middleware. Currently only supports `http`.
+ """
+ ),
+ ],
) -> Callable[[DecoratedCallable], DecoratedCallable]:
+ """
+ Add a middleware to the application.
+
+ Read more about it in the
+ [FastAPI docs for Middleware](https://fastapi.tiangolo.com/tutorial/middleware/).
+
+ ## Example
+
+ ```python
+ import time
+
+ from fastapi import FastAPI, Request
+
+ app = FastAPI()
+
+
+ @app.middleware("http")
+ async def add_process_time_header(request: Request, call_next):
+ start_time = time.time()
+ response = await call_next(request)
+ process_time = time.time() - start_time
+ response.headers["X-Process-Time"] = str(process_time)
+ return response
+ ```
+ """
+
def decorator(func: DecoratedCallable) -> DecoratedCallable:
self.add_middleware(BaseHTTPMiddleware, dispatch=func)
return func
@@ -933,8 +4592,46 @@ class FastAPI(Starlette):
return decorator
def exception_handler(
- self, exc_class_or_status_code: Union[int, Type[Exception]]
+ self,
+ exc_class_or_status_code: Annotated[
+ Union[int, Type[Exception]],
+ Doc(
+ """
+ The Exception class this would handle, or a status code.
+ """
+ ),
+ ],
) -> Callable[[DecoratedCallable], DecoratedCallable]:
+ """
+ Add an exception handler to the app.
+
+ Read more about it in the
+ [FastAPI docs for Handling Errors](https://fastapi.tiangolo.com/tutorial/handling-errors/).
+
+ ## Example
+
+ ```python
+ from fastapi import FastAPI, Request
+ from fastapi.responses import JSONResponse
+
+
+ class UnicornException(Exception):
+ def __init__(self, name: str):
+ self.name = name
+
+
+ app = FastAPI()
+
+
+ @app.exception_handler(UnicornException)
+ async def unicorn_exception_handler(request: Request, exc: UnicornException):
+ return JSONResponse(
+ status_code=418,
+ content={"message": f"Oops! {exc.name} did something. There goes a rainbow..."},
+ )
+ ```
+ """
+
def decorator(func: DecoratedCallable) -> DecoratedCallable:
self.add_exception_handler(exc_class_or_status_code, func)
return func
diff --git a/fastapi/background.py b/fastapi/background.py
index dd3bbe249..35ab1b227 100644
--- a/fastapi/background.py
+++ b/fastapi/background.py
@@ -1 +1,59 @@
-from starlette.background import BackgroundTasks as BackgroundTasks # noqa
+from typing import Any, Callable
+
+from starlette.background import BackgroundTasks as StarletteBackgroundTasks
+from typing_extensions import Annotated, Doc, ParamSpec # type: ignore [attr-defined]
+
+P = ParamSpec("P")
+
+
+class BackgroundTasks(StarletteBackgroundTasks):
+ """
+ A collection of background tasks that will be called after a response has been
+ sent to the client.
+
+ Read more about it in the
+ [FastAPI docs for Background Tasks](https://fastapi.tiangolo.com/tutorial/background-tasks/).
+
+ ## Example
+
+ ```python
+ from fastapi import BackgroundTasks, FastAPI
+
+ app = FastAPI()
+
+
+ def write_notification(email: str, message=""):
+ with open("log.txt", mode="w") as email_file:
+ content = f"notification for {email}: {message}"
+ email_file.write(content)
+
+
+ @app.post("/send-notification/{email}")
+ async def send_notification(email: str, background_tasks: BackgroundTasks):
+ background_tasks.add_task(write_notification, email, message="some notification")
+ return {"message": "Notification sent in the background"}
+ ```
+ """
+
+ def add_task(
+ self,
+ func: Annotated[
+ Callable[P, Any],
+ Doc(
+ """
+ The function to call after the response is sent.
+
+ It can be a regular `def` function or an `async def` function.
+ """
+ ),
+ ],
+ *args: P.args,
+ **kwargs: P.kwargs,
+ ) -> None:
+ """
+ Add a function to be called in the background after the response is sent.
+
+ Read more about it in the
+ [FastAPI docs for Background Tasks](https://fastapi.tiangolo.com/tutorial/background-tasks/).
+ """
+ return super().add_task(func, *args, **kwargs)
diff --git a/fastapi/datastructures.py b/fastapi/datastructures.py
index 3c96c56c7..ce03e3ce4 100644
--- a/fastapi/datastructures.py
+++ b/fastapi/datastructures.py
@@ -1,11 +1,21 @@
-from typing import Any, Callable, Dict, Iterable, Type, TypeVar, cast
+from typing import (
+ Any,
+ BinaryIO,
+ Callable,
+ Dict,
+ Iterable,
+ Optional,
+ Type,
+ TypeVar,
+ cast,
+)
from fastapi._compat import (
PYDANTIC_V2,
CoreSchema,
GetJsonSchemaHandler,
JsonSchemaValue,
- general_plain_validator_function,
+ with_info_plain_validator_function,
)
from starlette.datastructures import URL as URL # noqa: F401
from starlette.datastructures import Address as Address # noqa: F401
@@ -14,9 +24,120 @@ from starlette.datastructures import Headers as Headers # noqa: F401
from starlette.datastructures import QueryParams as QueryParams # noqa: F401
from starlette.datastructures import State as State # noqa: F401
from starlette.datastructures import UploadFile as StarletteUploadFile
+from typing_extensions import Annotated, Doc # type: ignore [attr-defined]
class UploadFile(StarletteUploadFile):
+ """
+ A file uploaded in a request.
+
+ Define it as a *path operation function* (or dependency) parameter.
+
+ If you are using a regular `def` function, you can use the `upload_file.file`
+ attribute to access the raw standard Python file (blocking, not async), useful and
+ needed for non-async code.
+
+ Read more about it in the
+ [FastAPI docs for Request Files](https://fastapi.tiangolo.com/tutorial/request-files/).
+
+ ## Example
+
+ ```python
+ from typing import Annotated
+
+ from fastapi import FastAPI, File, UploadFile
+
+ app = FastAPI()
+
+
+ @app.post("/files/")
+ async def create_file(file: Annotated[bytes, File()]):
+ return {"file_size": len(file)}
+
+
+ @app.post("/uploadfile/")
+ async def create_upload_file(file: UploadFile):
+ return {"filename": file.filename}
+ ```
+ """
+
+ file: Annotated[
+ BinaryIO,
+ Doc("The standard Python file object (non-async)."),
+ ]
+ filename: Annotated[Optional[str], Doc("The original file name.")]
+ size: Annotated[Optional[int], Doc("The size of the file in bytes.")]
+ headers: Annotated[Headers, Doc("The headers of the request.")]
+ content_type: Annotated[
+ Optional[str], Doc("The content type of the request, from the headers.")
+ ]
+
+ async def write(
+ self,
+ data: Annotated[
+ bytes,
+ Doc(
+ """
+ The bytes to write to the file.
+ """
+ ),
+ ],
+ ) -> None:
+ """
+ Write some bytes to the file.
+
+ You normally wouldn't use this from a file you read in a request.
+
+ To be awaitable, compatible with async, this is run in threadpool.
+ """
+ return await super().write(data)
+
+ async def read(
+ self,
+ size: Annotated[
+ int,
+ Doc(
+ """
+ The number of bytes to read from the file.
+ """
+ ),
+ ] = -1,
+ ) -> bytes:
+ """
+ Read some bytes from the file.
+
+ To be awaitable, compatible with async, this is run in threadpool.
+ """
+ return await super().read(size)
+
+ async def seek(
+ self,
+ offset: Annotated[
+ int,
+ Doc(
+ """
+ The position in bytes to seek to in the file.
+ """
+ ),
+ ],
+ ) -> None:
+ """
+ Move to a position in the file.
+
+ Any next read or write will be done from that position.
+
+ To be awaitable, compatible with async, this is run in threadpool.
+ """
+ return await super().seek(offset)
+
+ async def close(self) -> None:
+ """
+ Close the file.
+
+ To be awaitable, compatible with async, this is run in threadpool.
+ """
+ return await super().close()
+
@classmethod
def __get_validators__(cls: Type["UploadFile"]) -> Iterable[Callable[..., Any]]:
yield cls.validate
@@ -49,7 +170,7 @@ class UploadFile(StarletteUploadFile):
def __get_pydantic_core_schema__(
cls, source: Type[Any], handler: Callable[[Any], CoreSchema]
) -> CoreSchema:
- return general_plain_validator_function(cls._validate)
+ return with_info_plain_validator_function(cls._validate)
class DefaultPlaceholder:
diff --git a/fastapi/dependencies/utils.py b/fastapi/dependencies/utils.py
index e2915268c..96e07a45c 100644
--- a/fastapi/dependencies/utils.py
+++ b/fastapi/dependencies/utils.py
@@ -44,6 +44,7 @@ from fastapi._compat import (
serialize_sequence_value,
value_is_sequence,
)
+from fastapi.background import BackgroundTasks
from fastapi.concurrency import (
AsyncExitStack,
asynccontextmanager,
@@ -56,7 +57,7 @@ from fastapi.security.oauth2 import OAuth2, SecurityScopes
from fastapi.security.open_id_connect_url import OpenIdConnect
from fastapi.utils import create_response_field, get_path_param_names
from pydantic.fields import FieldInfo
-from starlette.background import BackgroundTasks
+from starlette.background import BackgroundTasks as StarletteBackgroundTasks
from starlette.concurrency import run_in_threadpool
from starlette.datastructures import FormData, Headers, QueryParams, UploadFile
from starlette.requests import HTTPConnection, Request
@@ -305,7 +306,7 @@ def add_non_field_param_to_dependency(
elif lenient_issubclass(type_annotation, Response):
dependant.response_param_name = param_name
return True
- elif lenient_issubclass(type_annotation, BackgroundTasks):
+ elif lenient_issubclass(type_annotation, StarletteBackgroundTasks):
dependant.background_tasks_param_name = param_name
return True
elif lenient_issubclass(type_annotation, SecurityScopes):
@@ -382,7 +383,14 @@ def analyze_param(
if lenient_issubclass(
type_annotation,
- (Request, WebSocket, HTTPConnection, Response, BackgroundTasks, SecurityScopes),
+ (
+ Request,
+ WebSocket,
+ HTTPConnection,
+ Response,
+ StarletteBackgroundTasks,
+ SecurityScopes,
+ ),
):
assert depends is None, f"Cannot specify `Depends` for type {type_annotation!r}"
assert (
@@ -510,14 +518,14 @@ async def solve_dependencies(
request: Union[Request, WebSocket],
dependant: Dependant,
body: Optional[Union[Dict[str, Any], FormData]] = None,
- background_tasks: Optional[BackgroundTasks] = None,
+ background_tasks: Optional[StarletteBackgroundTasks] = None,
response: Optional[Response] = None,
dependency_overrides_provider: Optional[Any] = None,
dependency_cache: Optional[Dict[Tuple[Callable[..., Any], Tuple[str]], Any]] = None,
) -> Tuple[
Dict[str, Any],
List[Any],
- Optional[BackgroundTasks],
+ Optional[StarletteBackgroundTasks],
Response,
Dict[Tuple[Callable[..., Any], Tuple[str]], Any],
]:
diff --git a/fastapi/encoders.py b/fastapi/encoders.py
index 30493697e..e50171393 100644
--- a/fastapi/encoders.py
+++ b/fastapi/encoders.py
@@ -22,6 +22,7 @@ from pydantic import BaseModel
from pydantic.color import Color
from pydantic.networks import AnyUrl, NameEmail
from pydantic.types import SecretBytes, SecretStr
+from typing_extensions import Annotated, Doc # type: ignore [attr-defined]
from ._compat import PYDANTIC_V2, Url, _model_dump
@@ -99,16 +100,107 @@ encoders_by_class_tuples = generate_encoders_by_class_tuples(ENCODERS_BY_TYPE)
def jsonable_encoder(
- obj: Any,
- include: Optional[IncEx] = None,
- exclude: Optional[IncEx] = None,
- by_alias: bool = True,
- exclude_unset: bool = False,
- exclude_defaults: bool = False,
- exclude_none: bool = False,
- custom_encoder: Optional[Dict[Any, Callable[[Any], Any]]] = None,
- sqlalchemy_safe: bool = True,
+ obj: Annotated[
+ Any,
+ Doc(
+ """
+ The input object to convert to JSON.
+ """
+ ),
+ ],
+ include: Annotated[
+ Optional[IncEx],
+ Doc(
+ """
+ Pydantic's `include` parameter, passed to Pydantic models to set the
+ fields to include.
+ """
+ ),
+ ] = None,
+ exclude: Annotated[
+ Optional[IncEx],
+ Doc(
+ """
+ Pydantic's `exclude` parameter, passed to Pydantic models to set the
+ fields to exclude.
+ """
+ ),
+ ] = None,
+ by_alias: Annotated[
+ bool,
+ Doc(
+ """
+ Pydantic's `by_alias` parameter, passed to Pydantic models to define if
+ the output should use the alias names (when provided) or the Python
+ attribute names. In an API, if you set an alias, it's probably because you
+ want to use it in the result, so you probably want to leave this set to
+ `True`.
+ """
+ ),
+ ] = True,
+ exclude_unset: Annotated[
+ bool,
+ Doc(
+ """
+ Pydantic's `exclude_unset` parameter, passed to Pydantic models to define
+ if it should exclude from the output the fields that were not explicitly
+ set (and that only had their default values).
+ """
+ ),
+ ] = False,
+ exclude_defaults: Annotated[
+ bool,
+ Doc(
+ """
+ Pydantic's `exclude_defaults` parameter, passed to Pydantic models to define
+ if it should exclude from the output the fields that had the same default
+ value, even when they were explicitly set.
+ """
+ ),
+ ] = False,
+ exclude_none: Annotated[
+ bool,
+ Doc(
+ """
+ Pydantic's `exclude_none` parameter, passed to Pydantic models to define
+ if it should exclude from the output any fields that have a `None` value.
+ """
+ ),
+ ] = False,
+ custom_encoder: Annotated[
+ Optional[Dict[Any, Callable[[Any], Any]]],
+ Doc(
+ """
+ Pydantic's `custom_encoder` parameter, passed to Pydantic models to define
+ a custom encoder.
+ """
+ ),
+ ] = None,
+ sqlalchemy_safe: Annotated[
+ bool,
+ Doc(
+ """
+ Exclude from the output any fields that start with the name `_sa`.
+
+ This is mainly a hack for compatibility with SQLAlchemy objects, they
+ store internal SQLAlchemy-specific state in attributes named with `_sa`,
+ and those objects can't (and shouldn't be) serialized to JSON.
+ """
+ ),
+ ] = True,
) -> Any:
+ """
+ Convert any object to something that can be encoded in JSON.
+
+ This is used internally by FastAPI to make sure anything you return can be
+ encoded as JSON before it is sent to the client.
+
+ You can also use it yourself, for example to convert objects before saving them
+ in a database that supports only JSON.
+
+ Read more about it in the
+ [FastAPI docs for JSON Compatible Encoder](https://fastapi.tiangolo.com/tutorial/encoder/).
+ """
custom_encoder = custom_encoder or {}
if custom_encoder:
if type(obj) in custom_encoder:
diff --git a/fastapi/exceptions.py b/fastapi/exceptions.py
index c1692f396..680d288e4 100644
--- a/fastapi/exceptions.py
+++ b/fastapi/exceptions.py
@@ -1,20 +1,141 @@
-from typing import Any, Dict, Optional, Sequence, Type
+from typing import Any, Dict, Optional, Sequence, Type, Union
from pydantic import BaseModel, create_model
from starlette.exceptions import HTTPException as StarletteHTTPException
-from starlette.exceptions import WebSocketException as WebSocketException # noqa: F401
+from starlette.exceptions import WebSocketException as StarletteWebSocketException
+from typing_extensions import Annotated, Doc # type: ignore [attr-defined]
class HTTPException(StarletteHTTPException):
+ """
+ An HTTP exception you can raise in your own code to show errors to the client.
+
+ This is for client errors, invalid authentication, invalid data, etc. Not for server
+ errors in your code.
+
+ Read more about it in the
+ [FastAPI docs for Handling Errors](https://fastapi.tiangolo.com/tutorial/handling-errors/).
+
+ ## Example
+
+ ```python
+ from fastapi import FastAPI, HTTPException
+
+ app = FastAPI()
+
+ items = {"foo": "The Foo Wrestlers"}
+
+
+ @app.get("/items/{item_id}")
+ async def read_item(item_id: str):
+ if item_id not in items:
+ raise HTTPException(status_code=404, detail="Item not found")
+ return {"item": items[item_id]}
+ ```
+ """
+
def __init__(
self,
- status_code: int,
- detail: Any = None,
- headers: Optional[Dict[str, str]] = None,
+ status_code: Annotated[
+ int,
+ Doc(
+ """
+ HTTP status code to send to the client.
+ """
+ ),
+ ],
+ detail: Annotated[
+ Any,
+ Doc(
+ """
+ Any data to be sent to the client in the `detail` key of the JSON
+ response.
+ """
+ ),
+ ] = None,
+ headers: Annotated[
+ Optional[Dict[str, str]],
+ Doc(
+ """
+ Any headers to send to the client in the response.
+ """
+ ),
+ ] = None,
) -> None:
super().__init__(status_code=status_code, detail=detail, headers=headers)
+class WebSocketException(StarletteWebSocketException):
+ """
+ A WebSocket exception you can raise in your own code to show errors to the client.
+
+ This is for client errors, invalid authentication, invalid data, etc. Not for server
+ errors in your code.
+
+ Read more about it in the
+ [FastAPI docs for WebSockets](https://fastapi.tiangolo.com/advanced/websockets/).
+
+ ## Example
+
+ ```python
+ from typing import Annotated
+
+ from fastapi import (
+ Cookie,
+ FastAPI,
+ WebSocket,
+ WebSocketException,
+ status,
+ )
+
+ app = FastAPI()
+
+ @app.websocket("/items/{item_id}/ws")
+ async def websocket_endpoint(
+ *,
+ websocket: WebSocket,
+ session: Annotated[str | None, Cookie()] = None,
+ item_id: str,
+ ):
+ if session is None:
+ raise WebSocketException(code=status.WS_1008_POLICY_VIOLATION)
+ await websocket.accept()
+ while True:
+ data = await websocket.receive_text()
+ await websocket.send_text(f"Session cookie is: {session}")
+ await websocket.send_text(f"Message text was: {data}, for item ID: {item_id}")
+ ```
+ """
+
+ def __init__(
+ self,
+ code: Annotated[
+ int,
+ Doc(
+ """
+ A closing code from the
+ [valid codes defined in the specification](https://datatracker.ietf.org/doc/html/rfc6455#section-7.4.1).
+ """
+ ),
+ ],
+ reason: Annotated[
+ Union[str, None],
+ Doc(
+ """
+ The reason to close the WebSocket connection.
+
+ It is UTF-8-encoded data. The interpretation of the reason is up to the
+ application, it is not specified by the WebSocket specification.
+
+ It could contain text that could be human-readable or interpretable
+ by the client code, etc.
+ """
+ ),
+ ] = None,
+ ) -> None:
+ super().__init__(code=code, reason=reason)
+
+
RequestErrorModel: Type[BaseModel] = create_model("Request")
WebSocketErrorModel: Type[BaseModel] = create_model("WebSocket")
@@ -47,3 +168,9 @@ class ResponseValidationError(ValidationException):
def __init__(self, errors: Sequence[Any], *, body: Any = None) -> None:
super().__init__(errors)
self.body = body
+
+ def __str__(self) -> str:
+ message = f"{len(self._errors)} validation errors:\n"
+ for err in self._errors:
+ message += f" {err}\n"
+ return message
diff --git a/fastapi/openapi/docs.py b/fastapi/openapi/docs.py
index 81f67dcc5..8cf0d17a1 100644
--- a/fastapi/openapi/docs.py
+++ b/fastapi/openapi/docs.py
@@ -3,8 +3,18 @@ from typing import Any, Dict, Optional
from fastapi.encoders import jsonable_encoder
from starlette.responses import HTMLResponse
+from typing_extensions import Annotated, Doc # type: ignore [attr-defined]
-swagger_ui_default_parameters = {
+swagger_ui_default_parameters: Annotated[
+ Dict[str, Any],
+ Doc(
+ """
+ Default configurations for Swagger UI.
+
+ You can use it as a template to add any other configurations needed.
+ """
+ ),
+] = {
"dom_id": "#swagger-ui",
"layout": "BaseLayout",
"deepLinking": True,
@@ -15,15 +25,91 @@ swagger_ui_default_parameters = {
def get_swagger_ui_html(
*,
- openapi_url: str,
- title: str,
- swagger_js_url: str = "https://cdn.jsdelivr.net/npm/swagger-ui-dist@5/swagger-ui-bundle.js",
- swagger_css_url: str = "https://cdn.jsdelivr.net/npm/swagger-ui-dist@5/swagger-ui.css",
- swagger_favicon_url: str = "https://fastapi.tiangolo.com/img/favicon.png",
- oauth2_redirect_url: Optional[str] = None,
- init_oauth: Optional[Dict[str, Any]] = None,
- swagger_ui_parameters: Optional[Dict[str, Any]] = None,
+ openapi_url: Annotated[
+ str,
+ Doc(
+ """
+ The OpenAPI URL that Swagger UI should load and use.
+
+ This is normally done automatically by FastAPI using the default URL
+ `/openapi.json`.
+ """
+ ),
+ ],
+ title: Annotated[
+ str,
+ Doc(
+ """
+ The HTML `