Установка проекта FastAPI

Установка и настройка FastAPI

Давайте начнём знакомство с фреймворком FastAPI и посмотрим, как мы можем установить и развернуть этот фреймворк. На официальном сайте мы можем перейти в раздел «Virtual environments» (виртуальное окружение), где есть инструкция по установке нашего FastAPI-проекта.

Первым делом мы должны перейти в директорию, где должен быть наш проект. Мы можем создать директорию под наш проект, например fastapi_test, либо выбрать какое-то другое название. Переходим в эту директорию и создаём наш проект.

Я сделал подобное действие, и у меня получилась папка fastapi_test, где я теперь могу попробовать развернуть новый проект. Первым делом нам говорят, что нужно активировать виртуальное окружение, в котором мы будем работать. Копируем команду python3 -m venv venv и создаём виртуальное окружение.

Моё виртуальное окружение было создано в текущей папке. Теперь мы должны активировать это окружение. Для того чтобы убедиться, что наше виртуальное окружение активно, мы можем увидеть, что у нас появилось (venv) в строке терминала, либо воспользоваться командой which python, которая покажет, что мы действительно работаем в виртуальном окружении.

Создание первого приложения

Теперь мы можем приступить к установке FastAPI. Устанавливается он достаточно просто командой pip install "fastapi[standard]". Есть несколько сборок FastAPI с различными пакетами, которые будут находиться внутри этого фреймворка. Сборка standard для большинства случаев может подойти.

После установки никаких файлов в нашем проекте не появилось — мы должны создавать их вручную. Для того чтобы наш проект начал работать, мы должны создать в корневой директории файл main.py, который будет главным входным файлом нашего проекта.

В нём мы импортируем FastAPI из библиотеки и определяем один главный роут, который будет выводить JSON-объект {"Hello": "World"}. Для того чтобы запустить наш проект, мы можем в консоли набрать команду fastapi dev main.py.

Как вы видите, наш проект был успешно развёрнут для develop-среды. Теперь у нас доступно два роута: главная страница и API-документация. Давайте попробуем перейти на главную страницу — у нас вывелся тот самый объект, который мы только что создали. Также доступна API-документация, в которой мы видим этот главный роут. Это основа того, как можно создать в FastAPI проект и начать с ним работать.