diff --git a/docs/en/mkdocs.yml b/docs/en/mkdocs.yml index 4ce180a8d..1c9faf5fa 100644 --- a/docs/en/mkdocs.yml +++ b/docs/en/mkdocs.yml @@ -44,6 +44,7 @@ nav: - it: /it/ - ja: /ja/ - ko: /ko/ + - pl: /pl/ - pt: /pt/ - ru: /ru/ - sq: /sq/ @@ -198,6 +199,8 @@ extra: name: ja - 日本語 - link: /ko/ name: ko - 한국어 + - link: /pl/ + name: pl - link: /pt/ name: pt - português - link: /ru/ diff --git a/docs/es/mkdocs.yml b/docs/es/mkdocs.yml index cd619ade6..1554cc3ea 100644 --- a/docs/es/mkdocs.yml +++ b/docs/es/mkdocs.yml @@ -44,6 +44,7 @@ nav: - it: /it/ - ja: /ja/ - ko: /ko/ + - pl: /pl/ - pt: /pt/ - ru: /ru/ - sq: /sq/ @@ -102,6 +103,8 @@ extra: name: ja - 日本語 - link: /ko/ name: ko - 한국어 + - link: /pl/ + name: pl - link: /pt/ name: pt - português - link: /ru/ diff --git a/docs/fr/mkdocs.yml b/docs/fr/mkdocs.yml index d9aac95f8..f1c66c759 100644 --- a/docs/fr/mkdocs.yml +++ b/docs/fr/mkdocs.yml @@ -44,6 +44,7 @@ nav: - it: /it/ - ja: /ja/ - ko: /ko/ + - pl: /pl/ - pt: /pt/ - ru: /ru/ - sq: /sq/ @@ -99,6 +100,8 @@ extra: name: ja - 日本語 - link: /ko/ name: ko - 한국어 + - link: /pl/ + name: pl - link: /pt/ name: pt - português - link: /ru/ diff --git a/docs/it/mkdocs.yml b/docs/it/mkdocs.yml index 9cadabcbb..f03730466 100644 --- a/docs/it/mkdocs.yml +++ b/docs/it/mkdocs.yml @@ -44,6 +44,7 @@ nav: - it: /it/ - ja: /ja/ - ko: /ko/ + - pl: /pl/ - pt: /pt/ - ru: /ru/ - sq: /sq/ @@ -95,6 +96,8 @@ extra: name: ja - 日本語 - link: /ko/ name: ko - 한국어 + - link: /pl/ + name: pl - link: /pt/ name: pt - português - link: /ru/ diff --git a/docs/ja/mkdocs.yml b/docs/ja/mkdocs.yml index 7ce4d6445..c2d905b13 100644 --- a/docs/ja/mkdocs.yml +++ b/docs/ja/mkdocs.yml @@ -44,6 +44,7 @@ nav: - it: /it/ - ja: /ja/ - ko: /ko/ + - pl: /pl/ - pt: /pt/ - ru: /ru/ - sq: /sq/ @@ -134,6 +135,8 @@ extra: name: ja - 日本語 - link: /ko/ name: ko - 한국어 + - link: /pl/ + name: pl - link: /pt/ name: pt - português - link: /ru/ diff --git a/docs/ko/mkdocs.yml b/docs/ko/mkdocs.yml index f5ae4b439..7f1991ed3 100644 --- a/docs/ko/mkdocs.yml +++ b/docs/ko/mkdocs.yml @@ -44,6 +44,7 @@ nav: - it: /it/ - ja: /ja/ - ko: /ko/ + - pl: /pl/ - pt: /pt/ - ru: /ru/ - sq: /sq/ @@ -101,6 +102,8 @@ extra: name: ja - 日本語 - link: /ko/ name: ko - 한국어 + - link: /pl/ + name: pl - link: /pt/ name: pt - português - link: /ru/ diff --git a/docs/pl/docs/index.md b/docs/pl/docs/index.md new file mode 100644 index 000000000..edc19fa48 --- /dev/null +++ b/docs/pl/docs/index.md @@ -0,0 +1,464 @@ + +{!../../../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.6+ 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. + +## Gold 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:
+
+* requests
- Required if you want to use the `TestClient`.
+* aiofiles
- Required if you want to use `FileResponse` or `StaticFiles`.
+* 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).
+* graphene
- Required for `GraphQLApp` support.
+* 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/pl/mkdocs.yml b/docs/pl/mkdocs.yml
new file mode 100644
index 000000000..a2c6102b8
--- /dev/null
+++ b/docs/pl/mkdocs.yml
@@ -0,0 +1,119 @@
+site_name: FastAPI
+site_description: FastAPI framework, high performance, easy to learn, fast to code, ready for production
+site_url: https://fastapi.tiangolo.com/pl/
+theme:
+ name: material
+ custom_dir: overrides
+ palette:
+ - scheme: default
+ primary: teal
+ accent: amber
+ toggle:
+ icon: material/lightbulb-outline
+ name: Switch to light mode
+ - scheme: slate
+ primary: teal
+ accent: amber
+ toggle:
+ icon: material/lightbulb
+ name: Switch to dark mode
+ features:
+ - search.suggest
+ - search.highlight
+ icon:
+ repo: fontawesome/brands/github-alt
+ logo: https://fastapi.tiangolo.com/img/icon-white.svg
+ favicon: https://fastapi.tiangolo.com/img/favicon.png
+ language: pl
+repo_name: tiangolo/fastapi
+repo_url: https://github.com/tiangolo/fastapi
+edit_uri: ''
+google_analytics:
+- UA-133183413-1
+- auto
+plugins:
+- search
+- markdownextradata:
+ data: data
+nav:
+- FastAPI: index.md
+- Languages:
+ - en: /
+ - es: /es/
+ - fr: /fr/
+ - it: /it/
+ - ja: /ja/
+ - ko: /ko/
+ - pl: /pl/
+ - pt: /pt/
+ - ru: /ru/
+ - sq: /sq/
+ - tr: /tr/
+ - uk: /uk/
+ - zh: /zh/
+markdown_extensions:
+- toc:
+ permalink: true
+- markdown.extensions.codehilite:
+ guess_lang: false
+- markdown_include.include:
+ base_path: docs
+- admonition
+- codehilite
+- extra
+- pymdownx.superfences:
+ custom_fences:
+ - name: mermaid
+ class: mermaid
+ format: !!python/name:pymdownx.superfences.fence_div_format ''
+- pymdownx.tabbed
+extra:
+ 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/tiangolo
+ - 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: /es/
+ name: es - español
+ - link: /fr/
+ name: fr - français
+ - link: /it/
+ name: it - italiano
+ - link: /ja/
+ name: ja - 日本語
+ - link: /ko/
+ name: ko - 한국어
+ - link: /pl/
+ name: pl
+ - link: /pt/
+ name: pt - português
+ - link: /ru/
+ name: ru - русский язык
+ - link: /sq/
+ name: sq - shqip
+ - 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://unpkg.com/mermaid@8.4.6/dist/mermaid.min.js
+- https://fastapi.tiangolo.com/js/termynal.js
+- https://fastapi.tiangolo.com/js/custom.js
diff --git a/docs/pl/overrides/.gitignore b/docs/pl/overrides/.gitignore
new file mode 100644
index 000000000..e69de29bb
diff --git a/docs/pt/mkdocs.yml b/docs/pt/mkdocs.yml
index ca5e77b01..230012d3b 100644
--- a/docs/pt/mkdocs.yml
+++ b/docs/pt/mkdocs.yml
@@ -44,6 +44,7 @@ nav:
- it: /it/
- ja: /ja/
- ko: /ko/
+ - pl: /pl/
- pt: /pt/
- ru: /ru/
- sq: /sq/
@@ -103,6 +104,8 @@ extra:
name: ja - 日本語
- link: /ko/
name: ko - 한국어
+ - link: /pl/
+ name: pl
- link: /pt/
name: pt - português
- link: /ru/
diff --git a/docs/ru/mkdocs.yml b/docs/ru/mkdocs.yml
index 55ee72fb6..b2b1b9aa7 100644
--- a/docs/ru/mkdocs.yml
+++ b/docs/ru/mkdocs.yml
@@ -44,6 +44,7 @@ nav:
- it: /it/
- ja: /ja/
- ko: /ko/
+ - pl: /pl/
- pt: /pt/
- ru: /ru/
- sq: /sq/
@@ -95,6 +96,8 @@ extra:
name: ja - 日本語
- link: /ko/
name: ko - 한국어
+ - link: /pl/
+ name: pl
- link: /pt/
name: pt - português
- link: /ru/
diff --git a/docs/sq/mkdocs.yml b/docs/sq/mkdocs.yml
index 7608f0220..9b255718b 100644
--- a/docs/sq/mkdocs.yml
+++ b/docs/sq/mkdocs.yml
@@ -44,6 +44,7 @@ nav:
- it: /it/
- ja: /ja/
- ko: /ko/
+ - pl: /pl/
- pt: /pt/
- ru: /ru/
- sq: /sq/
@@ -95,6 +96,8 @@ extra:
name: ja - 日本語
- link: /ko/
name: ko - 한국어
+ - link: /pl/
+ name: pl
- link: /pt/
name: pt - português
- link: /ru/
diff --git a/docs/tr/mkdocs.yml b/docs/tr/mkdocs.yml
index 30ee0ca2e..b65088447 100644
--- a/docs/tr/mkdocs.yml
+++ b/docs/tr/mkdocs.yml
@@ -44,6 +44,7 @@ nav:
- it: /it/
- ja: /ja/
- ko: /ko/
+ - pl: /pl/
- pt: /pt/
- ru: /ru/
- sq: /sq/
@@ -95,6 +96,8 @@ extra:
name: ja - 日本語
- link: /ko/
name: ko - 한국어
+ - link: /pl/
+ name: pl
- link: /pt/
name: pt - português
- link: /ru/
diff --git a/docs/uk/mkdocs.yml b/docs/uk/mkdocs.yml
index ab54f4f21..cecd2444f 100644
--- a/docs/uk/mkdocs.yml
+++ b/docs/uk/mkdocs.yml
@@ -44,6 +44,7 @@ nav:
- it: /it/
- ja: /ja/
- ko: /ko/
+ - pl: /pl/
- pt: /pt/
- ru: /ru/
- sq: /sq/
@@ -95,6 +96,8 @@ extra:
name: ja - 日本語
- link: /ko/
name: ko - 한국어
+ - link: /pl/
+ name: pl
- link: /pt/
name: pt - português
- link: /ru/
diff --git a/docs/zh/mkdocs.yml b/docs/zh/mkdocs.yml
index 9cea77745..b88f04382 100644
--- a/docs/zh/mkdocs.yml
+++ b/docs/zh/mkdocs.yml
@@ -44,6 +44,7 @@ nav:
- it: /it/
- ja: /ja/
- ko: /ko/
+ - pl: /pl/
- pt: /pt/
- ru: /ru/
- sq: /sq/
@@ -135,6 +136,8 @@ extra:
name: ja - 日本語
- link: /ko/
name: ko - 한국어
+ - link: /pl/
+ name: pl
- link: /pt/
name: pt - português
- link: /ru/