diff --git a/docs/az/mkdocs.yml b/docs/az/mkdocs.yml index 7d59451c1..22a77c6e2 100644 --- a/docs/az/mkdocs.yml +++ b/docs/az/mkdocs.yml @@ -40,6 +40,7 @@ nav: - Languages: - en: / - az: /az/ + - cs: /cs/ - de: /de/ - em: /em/ - es: /es/ @@ -104,6 +105,8 @@ extra: name: en - English - link: /az/ name: az + - link: /cs/ + name: cs - link: /de/ name: de - link: /em/ diff --git a/docs/cs/docs/index.md b/docs/cs/docs/index.md new file mode 100644 index 000000000..bde72f851 --- /dev/null +++ b/docs/cs/docs/index.md @@ -0,0 +1,473 @@ + +{!../../../docs/missing-translation.md!} + + +
++ FastAPI framework, high performance, easy to learn, fast to code, ready for production +
+ + +--- + +**Documentation**: https://fastapi.tiangolo.com + +**Source Code**: https://github.com/tiangolo/fastapi + +--- + +FastAPI is a modern, fast (high-performance), web framework for building APIs with Python 3.7+ based on standard Python type hints. + +The key features are: + +* **Fast**: Very high performance, on par with **NodeJS** and **Go** (thanks to Starlette and Pydantic). [One of the fastest Python frameworks available](#performance). +* **Fast to code**: Increase the speed to develop features by about 200% to 300%. * +* **Fewer bugs**: Reduce about 40% of human (developer) induced errors. * +* **Intuitive**: Great editor support. Completion everywhere. Less time debugging. +* **Easy**: Designed to be easy to use and learn. Less time reading docs. +* **Short**: Minimize code duplication. Multiple features from each parameter declaration. Fewer bugs. +* **Robust**: Get production-ready code. With automatic interactive documentation. +* **Standards-based**: Based on (and fully compatible with) the open standards for APIs: OpenAPI (previously known as Swagger) and JSON Schema. + +* estimation based on tests on an internal development team, building production applications. + +## Sponsors + + + +{% if sponsors %} +{% for sponsor in sponsors.gold -%} +async def
...uvicorn main:app --reload
...ujson
- for faster JSON "parsing".
+* email_validator
- for email validation.
+
+Used by Starlette:
+
+* httpx
- Required if you want to use the `TestClient`.
+* jinja2
- Required if you want to use the default template configuration.
+* python-multipart
- Required if you want to support form "parsing", with `request.form()`.
+* itsdangerous
- Required for `SessionMiddleware` support.
+* pyyaml
- Required for Starlette's `SchemaGenerator` support (you probably don't need it with FastAPI).
+* ujson
- Required if you want to use `UJSONResponse`.
+
+Used by FastAPI / Starlette:
+
+* uvicorn
- for the server that loads and serves your application.
+* orjson
- Required if you want to use `ORJSONResponse`.
+
+You can install all of these with `pip install "fastapi[all]"`.
+
+## License
+
+This project is licensed under the terms of the MIT license.
diff --git a/docs/cs/mkdocs.yml b/docs/cs/mkdocs.yml
new file mode 100644
index 000000000..539d7d65d
--- /dev/null
+++ b/docs/cs/mkdocs.yml
@@ -0,0 +1,154 @@
+site_name: FastAPI
+site_description: FastAPI framework, high performance, easy to learn, fast to code, ready for production
+site_url: https://fastapi.tiangolo.com/cs/
+theme:
+ name: material
+ custom_dir: overrides
+ palette:
+ - media: '(prefers-color-scheme: light)'
+ scheme: default
+ primary: teal
+ accent: amber
+ toggle:
+ icon: material/lightbulb
+ name: Switch to light mode
+ - media: '(prefers-color-scheme: dark)'
+ scheme: slate
+ primary: teal
+ accent: amber
+ toggle:
+ icon: material/lightbulb-outline
+ name: Switch to dark mode
+ features:
+ - search.suggest
+ - search.highlight
+ - content.tabs.link
+ icon:
+ repo: fontawesome/brands/github-alt
+ logo: https://fastapi.tiangolo.com/img/icon-white.svg
+ favicon: https://fastapi.tiangolo.com/img/favicon.png
+ language: cs
+repo_name: tiangolo/fastapi
+repo_url: https://github.com/tiangolo/fastapi
+edit_uri: ''
+plugins:
+- search
+- markdownextradata:
+ data: data
+nav:
+- FastAPI: index.md
+- Languages:
+ - en: /
+ - az: /az/
+ - cs: /cs/
+ - de: /de/
+ - es: /es/
+ - fa: /fa/
+ - fr: /fr/
+ - he: /he/
+ - hy: /hy/
+ - id: /id/
+ - it: /it/
+ - ja: /ja/
+ - ko: /ko/
+ - nl: /nl/
+ - pl: /pl/
+ - pt: /pt/
+ - ru: /ru/
+ - sq: /sq/
+ - sv: /sv/
+ - ta: /ta/
+ - tr: /tr/
+ - uk: /uk/
+ - zh: /zh/
+markdown_extensions:
+- toc:
+ permalink: true
+- markdown.extensions.codehilite:
+ guess_lang: false
+- mdx_include:
+ base_path: docs
+- admonition
+- codehilite
+- extra
+- pymdownx.superfences:
+ custom_fences:
+ - name: mermaid
+ class: mermaid
+ format: !!python/name:pymdownx.superfences.fence_code_format ''
+- pymdownx.tabbed:
+ alternate_style: true
+- attr_list
+- md_in_html
+extra:
+ analytics:
+ provider: google
+ property: G-YNEVN69SC3
+ social:
+ - icon: fontawesome/brands/github-alt
+ link: https://github.com/tiangolo/fastapi
+ - icon: fontawesome/brands/discord
+ link: https://discord.gg/VQjSZaeJmf
+ - icon: fontawesome/brands/twitter
+ link: https://twitter.com/fastapi
+ - icon: fontawesome/brands/linkedin
+ link: https://www.linkedin.com/in/tiangolo
+ - icon: fontawesome/brands/dev
+ link: https://dev.to/tiangolo
+ - icon: fontawesome/brands/medium
+ link: https://medium.com/@tiangolo
+ - icon: fontawesome/solid/globe
+ link: https://tiangolo.com
+ alternate:
+ - link: /
+ name: en - English
+ - link: /az/
+ name: az
+ - link: /cs/
+ name: cs
+ - link: /de/
+ name: de
+ - link: /es/
+ name: es - español
+ - link: /fa/
+ name: fa
+ - link: /fr/
+ name: fr - français
+ - link: /he/
+ name: he
+ - link: /hy/
+ name: hy
+ - link: /id/
+ name: id
+ - link: /it/
+ name: it - italiano
+ - link: /ja/
+ name: ja - 日本語
+ - link: /ko/
+ name: ko - 한국어
+ - link: /nl/
+ name: nl
+ - link: /pl/
+ name: pl
+ - link: /pt/
+ name: pt - português
+ - link: /ru/
+ name: ru - русский язык
+ - link: /sq/
+ name: sq - shqip
+ - link: /sv/
+ name: sv - svenska
+ - link: /ta/
+ name: ta - தமிழ்
+ - link: /tr/
+ name: tr - Türkçe
+ - link: /uk/
+ name: uk - українська мова
+ - link: /zh/
+ name: zh - 汉语
+extra_css:
+- https://fastapi.tiangolo.com/css/termynal.css
+- https://fastapi.tiangolo.com/css/custom.css
+extra_javascript:
+- https://fastapi.tiangolo.com/js/termynal.js
+- https://fastapi.tiangolo.com/js/custom.js
diff --git a/docs/cs/overrides/.gitignore b/docs/cs/overrides/.gitignore
new file mode 100644
index 000000000..e69de29bb
diff --git a/docs/de/mkdocs.yml b/docs/de/mkdocs.yml
index 87fe74697..8ee11d46c 100644
--- a/docs/de/mkdocs.yml
+++ b/docs/de/mkdocs.yml
@@ -40,6 +40,7 @@ nav:
- Languages:
- en: /
- az: /az/
+ - cs: /cs/
- de: /de/
- em: /em/
- es: /es/
@@ -105,6 +106,8 @@ extra:
name: en - English
- link: /az/
name: az
+ - link: /cs/
+ name: cs
- link: /de/
name: de
- link: /em/
diff --git a/docs/en/mkdocs.yml b/docs/en/mkdocs.yml
index fc21439ae..fd7decee8 100644
--- a/docs/en/mkdocs.yml
+++ b/docs/en/mkdocs.yml
@@ -40,6 +40,7 @@ nav:
- Languages:
- en: /
- az: /az/
+ - cs: /cs/
- de: /de/
- em: /em/
- es: /es/
@@ -211,6 +212,8 @@ extra:
name: en - English
- link: /az/
name: az
+ - link: /cs/
+ name: cs
- link: /de/
name: de
- link: /em/
diff --git a/docs/es/mkdocs.yml b/docs/es/mkdocs.yml
index 485a2dd70..85db87ad1 100644
--- a/docs/es/mkdocs.yml
+++ b/docs/es/mkdocs.yml
@@ -40,6 +40,7 @@ nav:
- Languages:
- en: /
- az: /az/
+ - cs: /cs/
- de: /de/
- em: /em/
- es: /es/
@@ -114,6 +115,8 @@ extra:
name: en - English
- link: /az/
name: az
+ - link: /cs/
+ name: cs
- link: /de/
name: de
- link: /em/
diff --git a/docs/fa/mkdocs.yml b/docs/fa/mkdocs.yml
index 914b46e1a..5bb1a2ff5 100644
--- a/docs/fa/mkdocs.yml
+++ b/docs/fa/mkdocs.yml
@@ -40,6 +40,7 @@ nav:
- Languages:
- en: /
- az: /az/
+ - cs: /cs/
- de: /de/
- em: /em/
- es: /es/
@@ -104,6 +105,8 @@ extra:
name: en - English
- link: /az/
name: az
+ - link: /cs/
+ name: cs
- link: /de/
name: de
- link: /em/
diff --git a/docs/fr/mkdocs.yml b/docs/fr/mkdocs.yml
index 36fbfb2d0..d416c067b 100644
--- a/docs/fr/mkdocs.yml
+++ b/docs/fr/mkdocs.yml
@@ -40,6 +40,7 @@ nav:
- Languages:
- en: /
- az: /az/
+ - cs: /cs/
- de: /de/
- em: /em/
- es: /es/
@@ -132,6 +133,8 @@ extra:
name: en - English
- link: /az/
name: az
+ - link: /cs/
+ name: cs
- link: /de/
name: de
- link: /em/
diff --git a/docs/he/mkdocs.yml b/docs/he/mkdocs.yml
index 094c5d82e..acf7ea8fd 100644
--- a/docs/he/mkdocs.yml
+++ b/docs/he/mkdocs.yml
@@ -40,6 +40,7 @@ nav:
- Languages:
- en: /
- az: /az/
+ - cs: /cs/
- de: /de/
- em: /em/
- es: /es/
@@ -104,6 +105,8 @@ extra:
name: en - English
- link: /az/
name: az
+ - link: /cs/
+ name: cs
- link: /de/
name: de
- link: /em/
diff --git a/docs/hy/mkdocs.yml b/docs/hy/mkdocs.yml
index ba7c687c1..5d251ff69 100644
--- a/docs/hy/mkdocs.yml
+++ b/docs/hy/mkdocs.yml
@@ -40,6 +40,7 @@ nav:
- Languages:
- en: /
- az: /az/
+ - cs: /cs/
- de: /de/
- em: /em/
- es: /es/
@@ -104,6 +105,8 @@ extra:
name: en - English
- link: /az/
name: az
+ - link: /cs/
+ name: cs
- link: /de/
name: de
- link: /em/
diff --git a/docs/id/mkdocs.yml b/docs/id/mkdocs.yml
index ca6e09551..55461328f 100644
--- a/docs/id/mkdocs.yml
+++ b/docs/id/mkdocs.yml
@@ -40,6 +40,7 @@ nav:
- Languages:
- en: /
- az: /az/
+ - cs: /cs/
- de: /de/
- em: /em/
- es: /es/
@@ -104,6 +105,8 @@ extra:
name: en - English
- link: /az/
name: az
+ - link: /cs/
+ name: cs
- link: /de/
name: de
- link: /em/
diff --git a/docs/it/mkdocs.yml b/docs/it/mkdocs.yml
index 4633dd017..251d86681 100644
--- a/docs/it/mkdocs.yml
+++ b/docs/it/mkdocs.yml
@@ -40,6 +40,7 @@ nav:
- Languages:
- en: /
- az: /az/
+ - cs: /cs/
- de: /de/
- em: /em/
- es: /es/
@@ -104,6 +105,8 @@ extra:
name: en - English
- link: /az/
name: az
+ - link: /cs/
+ name: cs
- link: /de/
name: de
- link: /em/
diff --git a/docs/ja/mkdocs.yml b/docs/ja/mkdocs.yml
index 9f4342e76..98a18cf4f 100644
--- a/docs/ja/mkdocs.yml
+++ b/docs/ja/mkdocs.yml
@@ -40,6 +40,7 @@ nav:
- Languages:
- en: /
- az: /az/
+ - cs: /cs/
- de: /de/
- em: /em/
- es: /es/
@@ -148,6 +149,8 @@ extra:
name: en - English
- link: /az/
name: az
+ - link: /cs/
+ name: cs
- link: /de/
name: de
- link: /em/
diff --git a/docs/ko/mkdocs.yml b/docs/ko/mkdocs.yml
index 1ab63e791..138ab678b 100644
--- a/docs/ko/mkdocs.yml
+++ b/docs/ko/mkdocs.yml
@@ -40,6 +40,7 @@ nav:
- Languages:
- en: /
- az: /az/
+ - cs: /cs/
- de: /de/
- em: /em/
- es: /es/
@@ -118,6 +119,8 @@ extra:
name: en - English
- link: /az/
name: az
+ - link: /cs/
+ name: cs
- link: /de/
name: de
- link: /em/
diff --git a/docs/nl/mkdocs.yml b/docs/nl/mkdocs.yml
index e187ee383..55c971aa4 100644
--- a/docs/nl/mkdocs.yml
+++ b/docs/nl/mkdocs.yml
@@ -40,6 +40,7 @@ nav:
- Languages:
- en: /
- az: /az/
+ - cs: /cs/
- de: /de/
- em: /em/
- es: /es/
@@ -104,6 +105,8 @@ extra:
name: en - English
- link: /az/
name: az
+ - link: /cs/
+ name: cs
- link: /de/
name: de
- link: /em/
diff --git a/docs/pl/mkdocs.yml b/docs/pl/mkdocs.yml
index c781f9783..af68f1b74 100644
--- a/docs/pl/mkdocs.yml
+++ b/docs/pl/mkdocs.yml
@@ -40,6 +40,7 @@ nav:
- Languages:
- en: /
- az: /az/
+ - cs: /cs/
- de: /de/
- em: /em/
- es: /es/
@@ -107,6 +108,8 @@ extra:
name: en - English
- link: /az/
name: az
+ - link: /cs/
+ name: cs
- link: /de/
name: de
- link: /em/
diff --git a/docs/pt/mkdocs.yml b/docs/pt/mkdocs.yml
index f51c3ecc2..9c3007e03 100644
--- a/docs/pt/mkdocs.yml
+++ b/docs/pt/mkdocs.yml
@@ -40,6 +40,7 @@ nav:
- Languages:
- en: /
- az: /az/
+ - cs: /cs/
- de: /de/
- em: /em/
- es: /es/
@@ -144,6 +145,8 @@ extra:
name: en - English
- link: /az/
name: az
+ - link: /cs/
+ name: cs
- link: /de/
name: de
- link: /em/
diff --git a/docs/ru/mkdocs.yml b/docs/ru/mkdocs.yml
index 24b89d0f5..5b6e338ce 100644
--- a/docs/ru/mkdocs.yml
+++ b/docs/ru/mkdocs.yml
@@ -40,6 +40,7 @@ nav:
- Languages:
- en: /
- az: /az/
+ - cs: /cs/
- de: /de/
- em: /em/
- es: /es/
@@ -125,6 +126,8 @@ extra:
name: en - English
- link: /az/
name: az
+ - link: /cs/
+ name: cs
- link: /de/
name: de
- link: /em/
diff --git a/docs/sq/mkdocs.yml b/docs/sq/mkdocs.yml
index 2766b0adf..ca20bce30 100644
--- a/docs/sq/mkdocs.yml
+++ b/docs/sq/mkdocs.yml
@@ -40,6 +40,7 @@ nav:
- Languages:
- en: /
- az: /az/
+ - cs: /cs/
- de: /de/
- em: /em/
- es: /es/
@@ -104,6 +105,8 @@ extra:
name: en - English
- link: /az/
name: az
+ - link: /cs/
+ name: cs
- link: /de/
name: de
- link: /em/
diff --git a/docs/sv/mkdocs.yml b/docs/sv/mkdocs.yml
index 5aa37ece6..ce6ee3f83 100644
--- a/docs/sv/mkdocs.yml
+++ b/docs/sv/mkdocs.yml
@@ -40,6 +40,7 @@ nav:
- Languages:
- en: /
- az: /az/
+ - cs: /cs/
- de: /de/
- em: /em/
- es: /es/
@@ -104,6 +105,8 @@ extra:
name: en - English
- link: /az/
name: az
+ - link: /cs/
+ name: cs
- link: /de/
name: de
- link: /em/
diff --git a/docs/ta/mkdocs.yml b/docs/ta/mkdocs.yml
index 884115044..d66fc5740 100644
--- a/docs/ta/mkdocs.yml
+++ b/docs/ta/mkdocs.yml
@@ -40,6 +40,7 @@ nav:
- Languages:
- en: /
- az: /az/
+ - cs: /cs/
- de: /de/
- em: /em/
- es: /es/
@@ -104,6 +105,8 @@ extra:
name: en - English
- link: /az/
name: az
+ - link: /cs/
+ name: cs
- link: /de/
name: de
- link: /em/
diff --git a/docs/tr/mkdocs.yml b/docs/tr/mkdocs.yml
index 23d6b9708..96306ee77 100644
--- a/docs/tr/mkdocs.yml
+++ b/docs/tr/mkdocs.yml
@@ -40,6 +40,7 @@ nav:
- Languages:
- en: /
- az: /az/
+ - cs: /cs/
- de: /de/
- em: /em/
- es: /es/
@@ -109,6 +110,8 @@ extra:
name: en - English
- link: /az/
name: az
+ - link: /cs/
+ name: cs
- link: /de/
name: de
- link: /em/
diff --git a/docs/uk/mkdocs.yml b/docs/uk/mkdocs.yml
index e9339997f..5ba681396 100644
--- a/docs/uk/mkdocs.yml
+++ b/docs/uk/mkdocs.yml
@@ -40,6 +40,7 @@ nav:
- Languages:
- en: /
- az: /az/
+ - cs: /cs/
- de: /de/
- em: /em/
- es: /es/
@@ -104,6 +105,8 @@ extra:
name: en - English
- link: /az/
name: az
+ - link: /cs/
+ name: cs
- link: /de/
name: de
- link: /em/
diff --git a/docs/zh/mkdocs.yml b/docs/zh/mkdocs.yml
index 906fcf1d6..015423752 100644
--- a/docs/zh/mkdocs.yml
+++ b/docs/zh/mkdocs.yml
@@ -40,6 +40,7 @@ nav:
- Languages:
- en: /
- az: /az/
+ - cs: /cs/
- de: /de/
- em: /em/
- es: /es/
@@ -161,6 +162,8 @@ extra:
name: en - English
- link: /az/
name: az
+ - link: /cs/
+ name: cs
- link: /de/
name: de
- link: /em/