Установка FastAPI и настройка окружения

FastAPI требует Python 3.8 или выше. В этом разделе описано, как установить FastAPI и настроить среду разработки.


Проверка версии Python

Перед установкой FastAPI проверьте версию Python:

$ python --version
Python 3.11.0

# 或者
$ python3 --version
Python 3.11.0

Если ваша версия Python ниже 3.8, сначала обновите Python.


Создайте виртуальное окружение

Рекомендуется устанавливать FastAPI в виртуальном окружении, чтобы избежать конфликтов с системными пакетами Python:

# 创建虚拟环境
$ python -m venv venv

# 激活虚拟环境(macOS/Linux)
$ source venv/bin/activate

# 激活虚拟环境(Windows)
$ venv\Scripts\activate

Виртуальные окружения — это лучшая практика в разработке на Python. Использование отдельного виртуального окружения для каждого проекта позволяет избежать конфликтов зависимостей между проектами.


Установите FastAPI

Установите FastAPI с помощью pip:

$ pip install fastapi

Эта команда устанавливает только основной пакет FastAPI. Если вам нужно установить FastAPI и все его дополнительные зависимости сразу, можно использовать:

$ pip install "fastapi[all]"

fastapi[all]Будут установлены следующие компоненты:

Название пакетаНазначение
uvicorn[standard]ASGI-сервер, используемый для запуска приложений FastAPI
python-multipartПоддержка данных форм и загрузки файлов
jinja2Движок HTML-шаблонов
python-jose[cryptography]Поддержка JWT-токенов
passlib[bcrypt]Хеширование паролей и шифрование
python-dotenvУправление переменными окружения

Установка Uvicorn

FastAPI — это ASGI-фреймворк, для запуска которого требуется ASGI-сервер. Наиболее часто используется Uvicorn:

$ pip install "uvicorn[standard]"

[standard]Это установит uvloop (высокопроизводительный цикл событий) и httptools (высокопроизводительный HTTP-парсер), что значительно повысит производительность.

ASGI (Asynchronous Server Gateway Interface) — это стандартный интерфейс между асинхронными веб-серверами Python и приложениями, и представляет собой асинхронную версию WSGI. Традиционные фреймворки, такие как Flask, используют WSGI (синхронный), тогда как FastAPI использует ASGI (асинхронный), что позволяет более эффективно обрабатывать конкурентные запросы.


Запустите ваше первое приложение FastAPI

После установки создайте файл с именемmain.pyФайл:

Пример

from fastapi import FastAPI

# Создать экземпляр приложения FastAPI
app = FastAPI()

# Определить GET-маршрут для корневого пути
@app.get("/")
async def root():
    return {"message": "Hello World"}

Запустите приложение в командной строке:

$ uvicorn main:app --reload

Описание параметра:

ПараметрОписание
main:appmainОтносится к имени файла main.py,appУказывает на имя переменной экземпляра FastAPI, созданной в файле
--reloadРежим разработки: автоматически перезагружает сервер после изменений кода (только для среды разработки)

После успешного запуска терминал отобразит:

INFO:     Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
INFO:     Started reloader process
INFO:     Started server process
INFO:     Waiting for application startup.
INFO:     Application startup complete.

Откройте браузер и перейдите по адресуhttp://127.0.0.1:8000, вы увидите следующий ответ JSON:

{"message": "Hello World"}

Тем временем FastAPI автоматически создаёт интерактивную документацию API:

АдресТип документаОписание
http://127.0.0.1:8000/docsSwagger UIИнтерфейс документации для интерактивного тестирования API
http://127.0.0.1:8000/redocReDocИнтерфейс документации, больше ориентированный на удобство чтения

Использование FastAPI CLI

Новая версия FastAPI предоставляетfastapiинструмент командной строки, который делает запуск приложений более удобным:

# 开发模式(自动重载)
$ fastapi dev

# 生产模式
$ fastapi run

fastapi devОн автоматически найдёт приложения FastAPI в проекте и запустит сервер разработки, что эквивалентноuvicorn main:app --reload。


Рекомендуемые инструменты разработки

ИнструментыОписание
VS CodeБесплатный и лёгкий, обеспечивает превосходный опыт разработки с FastAPI благодаря расширениям Python и Pylance
PyCharmПрофессиональная среда разработки Python со встроенными шаблонами проектов FastAPI и мощными средствами отладки
Alibaba QoderAI IDE для программирования, выпущенная Alibaba и глубоко кастомизированная на основе VS Code
ByteDance TraeИнструмент разработки на основе ИИ, выпущенный ByteDance, со встроенной поддержкой Python
Рекомендуется использовать VS Code + расширение Python, которое обеспечивает лучшую поддержку аннотаций типов FastAPI и автодополнения, и полностью бесплатно.
Другие расширения