Учебник - Руководство пользователя¶

🌐 Перевод выполнен с помощью ИИ и людей

Этот перевод был сделан ИИ под руководством людей. 🤝

В нем могут быть ошибки из-за неправильного понимания оригинального смысла или неестественности и т. д. 🤖

Вы можете улучшить этот перевод, помогая нам лучше направлять ИИ LLM.

This tutorial shows you how to use FastAPI with most of its features, step by step.

Каждый раздел постепенно основывается на предыдущих, но структура разделяет темы, так что вы можете сразу перейти к нужной теме для решения ваших конкретных задач по API.

Он также создан как справочник на будущее, чтобы вы могли вернуться и посмотреть именно то, что вам нужно.

Запустите код¶

Все блоки кода можно копировать и использовать напрямую (это действительно протестированные файлы Python).

Чтобы запустить любой из примеров, скопируйте код в файл main.py и запустите fastapi dev с помощью uv run:

$ <font color="#4E9A06">uv run fastapi</font> dev

  <span style="background-color:#009485"><font color="#D3D7CF"> FastAPI </font></span>  Starting development server 🚀

             Searching for package file structure from directories
             with <font color="#3465A4">__init__.py</font> files
             Importing from <font color="#75507B">/home/user/code/</font><font color="#AD7FA8">awesomeapp</font>

   <span style="background-color:#007166"><font color="#D3D7CF"> module </font></span>  🐍 main.py

     <span style="background-color:#007166"><font color="#D3D7CF"> code </font></span>  Importing the FastAPI app object from the module with
             the following code:

             <u style="text-decoration-style:solid">from </u><u style="text-decoration-style:solid"><b>main</b></u><u style="text-decoration-style:solid"> import </u><u style="text-decoration-style:solid"><b>app</b></u>

      <span style="background-color:#007166"><font color="#D3D7CF"> app </font></span>  Using import string: <font color="#3465A4">main:app</font>

   <span style="background-color:#007166"><font color="#D3D7CF"> server </font></span>  Server started at <font color="#729FCF"><u style="text-decoration-style:solid">http://127.0.0.1:8000</u></font>
   <span style="background-color:#007166"><font color="#D3D7CF"> server </font></span>  Documentation at <font color="#729FCF"><u style="text-decoration-style:solid">http://127.0.0.1:8000/docs</u></font>

      <span style="background-color:#007166"><font color="#D3D7CF"> tip </font></span>  Running in development mode, for production use:
             <b>fastapi run</b>

             Logs:

     <span style="background-color:#007166"><font color="#D3D7CF"> INFO </font></span>  Will watch for changes in these directories:
             <b>[</b><font color="#4E9A06">&apos;/home/user/code/awesomeapp&apos;</font><b>]</b>
     <span style="background-color:#007166"><font color="#D3D7CF"> INFO </font></span>  Uvicorn running on <font color="#729FCF"><u style="text-decoration-style:solid">http://127.0.0.1:8000</u></font> <b>(</b>Press CTRL+C
             to quit<b>)</b>
     <span style="background-color:#007166"><font color="#D3D7CF"> INFO </font></span>  Started reloader process <b>[</b><font color="#34E2E2"><b>383138</b></font><b>]</b> using WatchFiles
     <span style="background-color:#007166"><font color="#D3D7CF"> INFO </font></span>  Started server process <b>[</b><font color="#34E2E2"><b>383153</b></font><b>]</b>
     <span style="background-color:#007166"><font color="#D3D7CF"> INFO </font></span>  Waiting for application startup.
     <span style="background-color:#007166"><font color="#D3D7CF"> INFO </font></span>  Application startup complete.

НАСТОЯТЕЛЬНО рекомендуется написать или скопировать код, отредактировать его и запустить локально.

Использование кода в вашем редакторе кода — это то, что действительно показывает преимущества FastAPI: вы увидите, как мало кода нужно написать, все проверки типов, автозавершение и т.д.

Установка FastAPI¶

Первый шаг — настроить ваш проект и добавить FastAPI.

Установите uv, затем создайте проект и добавьте FastAPI:

$ uv init awesome-project --bare
$ cd awesome-project
$ uv add "fastapi[standard]"

---> 100%

uv add создаёт виртуальное окружение проекта в .venv, добавляет FastAPI в pyproject.toml и создаёт uv.lock, чтобы те же версии пакетов можно было установить позже.

Что делают эти команды

uv init: создаёт новый Python-проект.
awesome-project: создаёт проект в новой директории с этим именем.
--bare: создаёт только минимальный файл pyproject.toml, без генерации примерного main.py, README.md или других файлов. Файлы приложения вы создадите самостоятельно на следующих этапах этого руководства.

Затем cd awesome-project переходит в директорию нового проекта перед добавлением FastAPI.

uv будет использовать совместимую версию Python, уже установленную в вашей системе, или скачает её при необходимости.

Когда вы запускаете uv add, он выбирает совместимые версии FastAPI и всех пакетов, от которых зависит FastAPI. Он записывает точные версии в uv.lock, что позволяет позже установить те же версии пакетов на другом компьютере или при развертывании приложения.

Создание или обновление этого файла называется закреплением зависимостей проекта. uv делает это автоматически, когда вы добавляете пакет.

Варианты установки FastAPI

При установке с помощью uv add "fastapi[standard]" добавляются некоторые стандартные необязательные зависимости по умолчанию, включая fastapi-cloud-cli, который позволяет развернуть приложение на FastAPI Cloud.

Если вы не хотите иметь эти необязательные зависимости, вместо этого можно установить uv add fastapi.

Если вы хотите установить стандартные зависимости, но без fastapi-cloud-cli, можно установить с помощью uv add "fastapi[standard-no-fastapi-cloud-cli]".

Использование pip как альтернативы

Если вы предпочитаете управлять виртуальным окружением и пакетами вручную, создайте и активируйте виртуальное окружение, а затем установите FastAPI с помощью pip install "fastapi[standard]".

Подробные шаги читайте в руководстве по виртуальным окружениям.

Навыки AI-агента¶

FastAPI включает официальный навык для AI-агентов для написания кода. Он поставляется вместе с пакетом, поэтому его рекомендации остаются согласованными с версией FastAPI, установленной в вашем проекте, и обновляются при обновлении FastAPI.

После установки FastAPI в вашем проекте вы можете установить навык с помощью Library Skills:

uvx library-skills

Примечание

uvx — это псевдоним для uv tool run. Он запускает Library Skills во временном изолированном окружении, пока Library Skills сканирует пакеты, установленные в вашем проекте.

Навык совместим с Codex, Claude Code, Cursor, GitHub Copilot, Gemini CLI, Pi, OpenCode и большинством других агентов для написания кода. Для Claude Code выберите .claude/skills, когда вас спросят, куда установить навык.

Продвинутое руководство пользователя¶

Существует также Продвинутое руководство пользователя, которое вы сможете прочитать после Учебник - Руководство пользователя.

Продвинутое руководство пользователя основано на этом, использует те же концепции и обучает некоторым дополнительным функциям.

Но сначала вам следует прочитать Учебник - Руководство пользователя (то, что вы читаете прямо сейчас).

Оно спроектировано так, что вы можете создать полноценное приложение, используя только Учебник - Руководство пользователя, а затем расширить его различными способами, в зависимости от ваших потребностей, используя дополнительные идеи из Продвинутого руководства пользователя.