From 7b86cf26e29a755627b0d22709124c69bbc6f17c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=D0=9C=D0=B5=D0=BB=D1=8C=D0=BD=D0=B8=D0=BA=D0=BE=D0=B2=20?= =?UTF-8?q?=D0=9C=D0=B0=D0=BA=D1=81=D0=B8=D0=BC?= Date: Tue, 7 Oct 2025 07:54:41 +0300 Subject: [PATCH] docs: Updating the use of commands for the Russian and Chinese versions of the documentation --- docs/ru/docs/index.md | 49 ++++++++++++++++++++++++------------------- docs/zh/docs/index.md | 49 ++++++++++++++++++++++++------------------- 2 files changed, 54 insertions(+), 44 deletions(-) diff --git a/docs/ru/docs/index.md b/docs/ru/docs/index.md index 692c03ecb..557608960 100644 --- a/docs/ru/docs/index.md +++ b/docs/ru/docs/index.md @@ -122,28 +122,20 @@ FastAPI стоит на плечах гигантов: ## Установка -
- -```console -$ pip install fastapi - ----> 100% -``` - -
- -Вам также понадобится сервер ASGI для производства, такой как Uvicorn или Hypercorn. +Создайте и активируйте виртуальное окружение, а затем установите FastAPI:
```console -$ pip install "uvicorn[standard]" +$ pip install "fastapi[standard]" ---> 100% ```
+**Примечание**: Убедитесь, что вы помещаете `"fastapi[standard]"` в кавычки, чтобы это работало во всех терминалах. + ## Пример ### Создание @@ -204,11 +196,24 @@ async def read_item(item_id: int, q: Union[str, None] = None):
```console -$ uvicorn main:app --reload - +$ fastapi dev main.py + + ╭────────── FastAPI CLI - Development mode ───────────╮ + │ │ + │ Serving at: http://127.0.0.1:8000 │ + │ │ + │ API docs: http://127.0.0.1:8000/docs │ + │ │ + │ Running in development mode, for production use: │ + │ │ + │ fastapi run │ + │ │ + ╰─────────────────────────────────────────────────────╯ + +INFO: Will watch for changes in these directories: ['/home/user/code/awesomeapp'] INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit) -INFO: Started reloader process [28720] -INFO: Started server process [28722] +INFO: Started reloader process [2248755] using WatchFiles +INFO: Started server process [2248757] INFO: Waiting for application startup. INFO: Application startup complete. ``` @@ -216,13 +221,13 @@ INFO: Application startup complete.
-О команде uvicorn main:app --reload... +О команде fastapi dev main.py... + +Команда `fastapi dev` читает ваш файл `main.py`, обнаруживает в нем приложение **FastAPI** и запускает сервер с помощью Uvicorn. -Команда `uvicorn main:app` относится к: +По умолчанию `fastapi dev` запускается с включенной автоперезагрузкой для локальной разработки. -* `main`: файл `main.py` (модуль Python). -* `app`: объект, созданный внутри `main.py` с помощью строки `app = FastAPI()`. -* `--reload`: перезапуск сервера после изменения кода. Делайте это только во время разработки. +Вы можете узнать больше об этом в документации FastAPI CLI.
@@ -295,7 +300,7 @@ def update_item(item_id: int, item: Item): return {"item_name": item.name, "item_id": item_id} ``` -Сервер должен перезагрузиться автоматически (потому что вы добавили `--reload` к команде `uvicorn` выше). +Сервер `fastapi dev` должен перезагрузиться автоматически. ### Интерактивное обновление документации API diff --git a/docs/zh/docs/index.md b/docs/zh/docs/index.md index 680e2db50..a577d39dd 100644 --- a/docs/zh/docs/index.md +++ b/docs/zh/docs/index.md @@ -125,28 +125,20 @@ FastAPI 站在以下巨人的肩膀之上： ## 安装 -
- -```console -$ pip install fastapi - ----> 100% -``` - -
- -你还会需要一个 ASGI 服务器，生产环境可以使用 Uvicorn 或者 Hypercorn。 +创建并激活一个虚拟环境，然后安装 FastAPI：
```console -$ pip install "uvicorn[standard]" +$ pip install "fastapi[standard]" ---> 100% ```
+**注意**：确保将 `"fastapi[standard]"` 放在引号中，以便在所有终端中正常工作。 + ## 示例 ### 创建 @@ -207,11 +199,24 @@ async def read_item(item_id: int, q: Union[str, None] = None):
```console -$ uvicorn main:app --reload - +$ fastapi dev main.py + + ╭────────── FastAPI CLI - Development mode ───────────╮ + │ │ + │ Serving at: http://127.0.0.1:8000 │ + │ │ + │ API docs: http://127.0.0.1:8000/docs │ + │ │ + │ Running in development mode, for production use: │ + │ │ + │ fastapi run │ + │ │ + ╰─────────────────────────────────────────────────────╯ + +INFO: Will watch for changes in these directories: ['/home/user/code/awesomeapp'] INFO: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit) -INFO: Started reloader process [28720] -INFO: Started server process [28722] +INFO: Started reloader process [2248755] using WatchFiles +INFO: Started server process [2248757] INFO: Waiting for application startup. INFO: Application startup complete. ``` @@ -219,13 +224,13 @@ INFO: Application startup complete.
-关于 uvicorn main:app --reload 命令...... +关于 fastapi dev main.py 命令...... + +`fastapi dev` 命令会读取你的 `main.py` 文件，检测其中的 **FastAPI** 应用，并使用 Uvicorn 启动服务器。 - `uvicorn main:app` 命令含义如下: +默认情况下，`fastapi dev` 会启用自动重载功能用于本地开发。 -* `main`：`main.py` 文件（一个 Python "模块"）。 -* `app`：在 `main.py` 文件中通过 `app = FastAPI()` 创建的对象。 -* `--reload`：让服务器在更新代码后重新启动。仅在开发时使用该选项。 +你可以在 FastAPI CLI 文档 中了解更多信息。
@@ -298,7 +303,7 @@ def update_item(item_id: int, item: Item): return {"item_name": item.name, "item_id": item_id} ``` -服务器将会自动重载（因为在上面的步骤中你向 `uvicorn` 命令添加了 `--reload` 选项）。 +`fastapi dev` 服务器将会自动重载。 ### 交互式 API 文档升级