diff --git a/docs/ru/docs/index.md b/docs/ru/docs/index.md
index c5dac9c392def..135fd17217792 100644
--- a/docs/ru/docs/index.md
+++ b/docs/ru/docs/index.md
@@ -6,7 +6,7 @@
- FastAPI framework, high performance, easy to learn, fast to code, ready for production
+ FastAPI фреймворк, лучшая производительность, низкий порог входа, высокая скорость разработки, production-ready решение
@@ -22,29 +22,28 @@
---
-**Documentation**: https://fastapi.tiangolo.com
+**Документация**: https://fastapi.tiangolo.com
-**Source Code**: https://github.com/tiangolo/fastapi
+**Исходный код**: 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.
+FastAPI - это современный, высокопроизводительный веб-фреймворк для построения API на Python 3.6+ в основе которого лежит стандартная аннотация типов.
-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).
+* **Эффективность**: Отличная производительность наравне с **NodeJS** и **Go** (благодаря Starlette и Pydantic). [Один из самых быстрых Python фреймворков](#performance).
+* **Скорость разработки**: Увеличьте свою скорость разработки на 200–300%. *
+* **Меньше багов**: На 40% меньше багов при разработке. *
+* **Авто дополнение**: Отличная поддержка IDE – тратьте меньше времени на отладку.
+* **Простота**: Низкий порог вхождения. Простая и понятная документация.
+* **Лаконичность**: Минимальное дублирование кода. Большое количество готовых решений.
+* **Надёжность**: Получите production-ready код с генерацией интерактивной документации.
+* **Специфицирован**: Основан, и полностью совместим, на стандартах API: OpenAPI (так же известный как Swagger) и JSON Schema.
-* **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
+## Золотые спонсоры
@@ -56,9 +55,9 @@ The key features are:
-Other sponsors
+Все спонсоры
-## Opinions
+## Что думают о FastAPI разработчики
"_[...] I'm using **FastAPI** a ton these days. [...] I'm actually planning to use it for all of my team's **ML services at Microsoft**. Some of them are getting integrated into the core **Windows** product and some **Office** products._"
@@ -98,24 +97,24 @@ The key features are:
---
-## **Typer**, the FastAPI of CLIs
+## **Typer** – FastAPI для CLI приложений
-If you are building a CLI app to be used in the terminal instead of a web API, check out **Typer**.
+Если вы разрабатываете CLI-приложение обратите внимание **Typer**.
-**Typer** is FastAPI's little sibling. And it's intended to be the **FastAPI of CLIs**. ⌨️ 🚀
+**Typer** это младший брат FastAPI's. Используйте его вместо **FastAPI** для **CLI-приложений**. ⌨️ 🚀
-## Requirements
+## Требования
Python 3.6+
-FastAPI stands on the shoulders of giants:
+FastAPI стоит на плечах гигантов:
-* Starlette for the web parts.
-* Pydantic for the data parts.
+* Starlette для веб части.
+* Pydantic для работы с данными.
-## Installation
+## Установка
@@ -127,7 +126,7 @@ $ pip install fastapi
-You will also need an ASGI server, for production such as Uvicorn or Hypercorn.
+Вам также понадобится ASGI сервер например Uvicorn или Hypercorn.
@@ -139,11 +138,11 @@ $ pip install uvicorn[standard]
-## Example
+## Пример
-### Create it
+### Создание
-* Create a file `main.py` with:
+* Создайте файл `main.py`:
```Python
from typing import Optional
@@ -164,9 +163,9 @@ def read_item(item_id: int, q: Optional[str] = None):
```
-Or use async def...
+Или используйте async def...
-If your code uses `async` / `await`, use `async def`:
+Если ваш код использует `async` / `await`, используйте `async def`:
```Python hl_lines="9 14"
from typing import Optional
@@ -186,15 +185,15 @@ async def read_item(item_id: int, q: Optional[str] = None):
return {"item_id": item_id, "q": q}
```
-**Note**:
+**Примечание**:
-If you don't know, check the _"In a hurry?"_ section about `async` and `await` in the docs.
+Если вы не понимаете о чем идёт речь, ознакомьтесь с разделом об `async` и `await` в документации.
-### Run it
+### Запуск
-Run the server with:
+Запустите сервер командой:
@@ -211,54 +210,54 @@ INFO: Application startup complete.
-About the command uvicorn main:app --reload...
+О команде uvicorn main:app --reload...
-The command `uvicorn main:app` refers to:
+Команда `uvicorn main:app` состоит из:
-* `main`: the file `main.py` (the Python "module").
-* `app`: the object created inside of `main.py` with the line `app = FastAPI()`.
-* `--reload`: make the server restart after code changes. Only do this for development.
+* `main`: файл `main.py` (Python модуль).
+* `app`: объект который мы создаём в `main.py` строчкой `app = FastAPI()`.
+* `--reload`: перезапуск сервера при изменении в коде. Используйте этот ключ только во время разработки.
-### Check it
+### Проверка
-Open your browser at http://127.0.0.1:8000/items/5?q=somequery.
+Откройте в браузере http://127.0.0.1:8000/items/5?q=somequery.
-You will see the JSON response as:
+Вы увидите JSON-ответ:
```JSON
{"item_id": 5, "q": "somequery"}
```
-You already created an API that:
+Мы создали API который:
-* Receives HTTP requests in the _paths_ `/` and `/items/{item_id}`.
-* Both _paths_ take `GET` operations (also known as HTTP _methods_).
-* The _path_ `/items/{item_id}` has a _path parameter_ `item_id` that should be an `int`.
-* The _path_ `/items/{item_id}` has an optional `str` _query parameter_ `q`.
+* Принимать HTTP запросы по _маршрутам_ `/` и `/items/{item_id}`.
+* Оба _маршрута_ умеют обрабатывать `GET`-операцию ( HTTP _метод_).
+* _Маршрут_ `/items/{item_id}` имеет _параметр_ `item_id` типа `int`.
+* _Маршрут_ `/items/{item_id}` имеет необязательный _параметр_ `q` типа `str`.
-### Interactive API docs
+### Интерактивная API документация
-Now go to http://127.0.0.1:8000/docs.
+Откройте в браузере http://127.0.0.1:8000/docs.
-You will see the automatic interactive API documentation (provided by Swagger UI):
+Перед вами автоматически сгенерированная документация нашего API (предоставленная Swagger UI):
-### Alternative API docs
+### Альтернативная API документация
-And now, go to http://127.0.0.1:8000/redoc.
+Откройте в браузере http://127.0.0.1:8000/redoc.
-You will see the alternative automatic documentation (provided by ReDoc):
+Это документация предоставлена ReDoc:
-## Example upgrade
+## Улучшаем пример
-Now modify the file `main.py` to receive a body from a `PUT` request.
+Изменим код `main.py`чтобы получить тело `PUT` запроса.
-Declare the body using standard Python types, thanks to Pydantic.
+Определим тело запроса стандартными аннотациями типов Python используя Pydantic.
```Python hl_lines="4 9-12 25-27"
from typing import Optional
@@ -290,175 +289,175 @@ def update_item(item_id: int, item: Item):
return {"item_name": item.name, "item_id": item_id}
```
-The server should reload automatically (because you added `--reload` to the `uvicorn` command above).
+Сервер должен автоматически перезагрузиться (благодаря ключу `--reload` у команды `uvicorn` выше).
-### Interactive API docs upgrade
+### Изменения в документации
-Now go to http://127.0.0.1:8000/docs.
+Отройте в браузере http://127.0.0.1:8000/docs.
-* The interactive API documentation will be automatically updated, including the new body:
+* Интерактивная документация API автоматически обновилась:
-* Click on the button "Try it out", it allows you to fill the parameters and directly interact with the API:
+* Нажмите кнопку "Try it out" и заполните форму. Так вы можете напрямую взаимодействовать с API:
-* Then click on the "Execute" button, the user interface will communicate with your API, send the parameters, get the results and show them on the screen:
+* После заполнения формы нажмите "Execute", пользовательский интерфейс документации соединится с API, отошлет параметры, запросит результаты и выведет их вам на экран:
-### Alternative API docs upgrade
+### Обновление альтернативной документации
-And now, go to http://127.0.0.1:8000/redoc.
+Перейдите по адресу http://127.0.0.1:8000/redoc.
-* The alternative documentation will also reflect the new query parameter and body:
+* ReDoc документация также обновилась:
-### Recap
+### Итог
-In summary, you declare **once** the types of parameters, body, etc. as function parameters.
+Вы **один раз** задали типы параметров, тела запроса, и т. д. как параметры функции.
-You do that with standard modern Python types.
+Вы сделали это используя стандартные средства Python.
-You don't have to learn a new syntax, the methods or classes of a specific library, etc.
+Вам не пришлось учить новый синтаксис, методы или классы специальной библиотеки.
-Just standard **Python 3.6+**.
+Только стандартный **Python 3.6+**.
-For example, for an `int`:
+Пример для типа `int`:
```Python
item_id: int
```
-or for a more complex `Item` model:
+Немного более сложная модель `Item`:
```Python
item: Item
```
-...and with that single declaration you get:
+...и благодаря всего одному описанию вы получаете:
-* Editor support, including:
- * Completion.
- * Type checks.
-* Validation of data:
- * Automatic and clear errors when the data is invalid.
- * Validation even for deeply nested JSON objects.
-* Conversion of input data: coming from the network to Python data and types. Reading from:
+* Поддержку IDE, включая:
+ * Авто дополнение.
+ * Проверку типов.
+* Валидацию данных:
+ * Автоматические и понятные ошибки в случае невалидных данных.
+ * Валидация для JSON-объектов любой вложенности.
+* Преобразование входных данных. Поддерживаемые форматы:
* JSON.
- * Path parameters.
- * Query parameters.
+ * Параметры для маршрутов, например, `/item/{id}`..
+ * Параметры запросов.
* Cookies.
- * Headers.
- * Forms.
- * Files.
-* Conversion of output data: converting from Python data and types to network data (as JSON):
- * Convert Python types (`str`, `int`, `float`, `bool`, `list`, etc).
- * `datetime` objects.
- * `UUID` objects.
- * Database models.
- * ...and many more.
-* Automatic interactive API documentation, including 2 alternative user interfaces:
+ * Заголовки запросов.
+ * Формы.
+ * Файлы.
+* Преобразование выходных данных:
+ * Преобразование Python типов (`str`, `int`, `float`, `bool`, `list`, и другие).
+ * `datetime`.
+ * `UUID`.
+ * Модели для работы с базой данных.
+ * ...и многое другое.
+* Автоматическая интерактивная документация API, включающая в себя два разных интерфейса:
* Swagger UI.
* ReDoc.
---
-Coming back to the previous code example, **FastAPI** will:
-
-* Validate that there is an `item_id` in the path for `GET` and `PUT` requests.
-* Validate that the `item_id` is of type `int` for `GET` and `PUT` requests.
- * If it is not, the client will see a useful, clear error.
-* Check if there is an optional query parameter named `q` (as in `http://127.0.0.1:8000/items/foo?q=somequery`) for `GET` requests.
- * As the `q` parameter is declared with `= None`, it is optional.
- * Without the `None` it would be required (as is the body in the case with `PUT`).
-* For `PUT` requests to `/items/{item_id}`, Read the body as JSON:
- * Check that it has a required attribute `name` that should be a `str`.
- * Check that it has a required attribute `price` that has to be a `float`.
- * Check that it has an optional attribute `is_offer`, that should be a `bool`, if present.
- * All this would also work for deeply nested JSON objects.
-* Convert from and to JSON automatically.
-* Document everything with OpenAPI, that can be used by:
- * Interactive documentation systems.
- * Automatic client code generation systems, for many languages.
-* Provide 2 interactive documentation web interfaces directly.
+Если вернуться к примеру кода, **FastAPI** делает следующее:
+
+* Проверяет, существует ли параметр `item_id` в маршрутах для `GET` и `PUT` запросов.
+* Проверяет, является ли параметр `item_id` типом `int` для `GET` и `PUT` запросов.
+ * Если нет, API отошлет клиенту понятное сообщение об ошибке.
+* Проверяет необязательный параметр `q` (as in `http://127.0.0.1:8000/items/foo?q=somequery`) для `GET` запросов.
+ * Если параметр `q` объявлен со значением `= None`, он автоматически считается необязательным.
+ * Без инструкции `None` параметр считается обязательным (например, как в `PUT`-запросе).
+* Для `PUT`-запросов к `/items/{item_id}`, парсит тело запроса как JSON:
+ * Проверяет, существует ли обязательный параметр `name` и является ли он строкой `str`.
+ * Проверяет, существует ли обязательный параметр `price` и является ли он типом `float`.
+ * Проверяет, существует ли _необязательный_ параметр `is_offer`, который должен быть `bool`, если существует
+ * И всё это работает для JSON-объектов любой вложенности.
+* Конвертирует данные в/из JSON.
+* Документирует всё по стандарту OpenAPI, который легко использовать в:
+ * Интерактивных системах документации.
+ * Автоматической генерации кода на клиенте, на любом языке.
+* Добавляет 2 прямых интерактивных пользовательских интерфейса для документации и проверки методов API.
---
-We just scratched the surface, but you already get the idea of how it all works.
+Мы прошлись по верхам, однако вы уже имеете представление о том как работает **FastApi**.
-Try changing the line with:
+Попробуйте изменить в строке:
```Python
return {"item_name": item.name, "item_id": item_id}
```
-...from:
+...Это:
```Python
... "item_name": item.name ...
```
-...to:
+...На:
```Python
... "item_price": item.price ...
```
-...and see how your editor will auto-complete the attributes and know their types:
+...и вы увидите как ваша IDE будет авто-дополнять атрибуты и знать их типы:
-For a more complete example including more features, see the Tutorial - User Guide.
+Для более комплексных примеров с большим количеством функционала смотрите Tutorial - User Guide.
-**Spoiler alert**: the tutorial - user guide includes:
+**Спойлер**: Туториал содержит информацию:
-* Declaration of **parameters** from other different places as: **headers**, **cookies**, **form fields** and **files**.
-* How to set **validation constraints** as `maximum_length` or `regex`.
-* A very powerful and easy to use **Dependency Injection** system.
-* Security and authentication, including support for **OAuth2** with **JWT tokens** and **HTTP Basic** auth.
-* More advanced (but equally easy) techniques for declaring **deeply nested JSON models** (thanks to Pydantic).
-* Many extra features (thanks to Starlette) as:
+* Объявление **параметров** из других источников: **заголовков HTTP**, **cookies**, **форм** и **файлов**.
+* Как установить **ограничения валидации**, например `maximum_length` или `regex`.
+* Очень мощный и лёгкий в использовании механизм **Dependency Injection**.
+* Авторизации и безопасность, включая поддержку OAuth2 с JWT-токенов и HTTP-авторизации.
+* Более продвинутых (но таких же просты) техник для описания **JSON моделей с большой вложенностью** (благодаря Pydantic).
+* Много дополнительного функционала Starlette:
* **WebSockets**
* **GraphQL**
- * extremely easy tests based on `requests` and `pytest`
+ * Невероятно простое тестирование основанное на `requests` и `pytest`
* **CORS**
* **Cookie Sessions**
- * ...and more.
+ * ...и многое другое.
-## Performance
+## Производительность
-Independent TechEmpower benchmarks show **FastAPI** applications running under Uvicorn as one of the fastest Python frameworks available, only below Starlette and Uvicorn themselves (used internally by FastAPI). (*)
+Независимые тесты производительности от TechEmpower показывают, что приложения **FastAPI** запущенные на Uvicorn сервере, являются одними из самых быстрых Python приложениями, уступая только Starlette и Uvicorn (они используются внутри FastAPI). (*)
-To understand more about it, see the section Benchmarks.
+Больше информации вы можете узнать тут – Benchmarks.
-## Optional Dependencies
+## Необязательные зависимости
-Used by Pydantic:
+Используемые Pydantic:
-* ujson - for faster JSON "parsing".
-* email_validator - for email validation.
+* ujson - для быстрого JSON "парсинга".
+* email_validator - для валидации email.
-Used by Starlette:
+Используемые 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`.
+* requests - Необходимо при использовании `TestClient`.
+* aiofiles - Для файловых ответов от сервера `FileResponse` или `StaticFiles`.
+* jinja2 - Для стандартных шаблонов jinja.
+* python-multipart - Для поддержки "парсинга", форм благодаря `request.form()`.
+* itsdangerous - Необходимо для поддержки `SessionMiddleware`.
+* pyyaml - Поддержка `SchemaGenerator` для Starlette (скорее всего в FastAPI вам это не нужно).
+* graphene - Для поддержки `GraphQLApp`.
+* ujson - Необходимо чтобы использовать `UJSONResponse`.
-Used by FastAPI / Starlette:
+Используемые FastAPI / Starlette:
-* uvicorn - for the server that loads and serves your application.
-* orjson - Required if you want to use `ORJSONResponse`.
+* uvicorn - Сервер для асинхронных приложений на Python.
+* orjson - Для использования класса `ORJSONResponse`.
-You can install all of these with `pip install fastapi[all]`.
+Вы можете установить их все с помощью `pip install fastapi[all]`.
-## License
+## Лицензия
-This project is licensed under the terms of the MIT license.
+Проект распространяется под лицензией MIT.
\ No newline at end of file