Сайты и приложения

Как выложить API на FastAPI в интернет

· 4 мин чтения

Коротко

Чтобы выложить API на FastAPI, перечислите fastapi и uvicorn в requirements.txt, запускайте uvicorn на 0.0.0.0 с портом из переменной PORT и загрузите код. Netrun сам определит Python, соберет проект и выдаст ссылку с HTTPS, а интерактивная документация будет открываться по пути /docs. Свой сервер, nginx и ручной сертификат для этого не нужны.

  • Чтобы FastAPI-приложение принимало запросы из интернета, нужен сервер приложений uvicorn, указанный в requirements.txt вместе с fastapi.
  • Uvicorn по умолчанию слушает адрес 127.0.0.1, и снаружи приложение доступно, только если запустить его на 0.0.0.0.
  • Netrun передает приложению порт через переменную окружения PORT, поэтому номер порта не нужно прописывать в коде.
  • FastAPI сам отдает интерактивную документацию по пути /docs и альтернативную по пути /redoc.
  • На бесплатном тарифе Netrun API засыпает без запросов и просыпается при первом обращении, поэтому первый ответ после паузы приходит на несколько секунд позже.

Обычно, чтобы открыть доступ к своему API на FastAPI из интернета, нужно арендовать VPS, поставить на него Python, разобраться с uvicorn, настроить nginx как прокси, выпустить и продлевать SSL-сертификат, а потом еще следить, чтобы процесс не падал после перезагрузки. Для пет-проекта или первого сервиса это часы работы над тем, что к самому коду отношения не имеет.

Netrun убирает эту инфраструктуру: вы загружаете код, платформа сама понимает, что это Python-проект, собирает его и выдает публичную ссылку с HTTPS. Ни сервера, ни nginx, ни ручного сертификата. Ниже — как выложить ваш API за несколько минут.

  1. Соберите requirements.txt#

    Положите в корень проекта файл requirements.txt и перечислите в нем зависимости — как минимум fastapi и uvicorn. uvicorn — это сервер, который запускает ваше асинхронное приложение FastAPI и принимает запросы. По этому файлу Netrun поймет, что нужно установить. Папку venv с самими библиотеками класть не нужно — платформа поставит их сама.

  2. Слушайте порт из переменной окружения#

    Запустите uvicorn так, чтобы он слушал host 0.0.0.0 и порт, который Netrun передает через переменную окружения (платформа пробрасывает нужный порт сама). Не прописывайте порт числом в коде — берите его из окружения, например через os.environ. Так ваш API окажется доступен по выданной ссылке.

  3. Вынесите секреты в переменные окружения#

    Ключи сторонних сервисов, токены и строку подключения к базе данных не храните в коде — читайте их из переменных окружения. При настройке проекта Netrun спросит эти значения и подставит их в окружение, так что секреты не попадут в репозиторий и не утекут вместе с кодом.

  4. Загрузите код в Netrun#

    Загрузите проект ZIP-архивом или импортом из GitHub-репозитория, в том числе приватного. Netrun определит, что это Python, и соберет приложение автоматически — отдельно указывать язык или писать Dockerfile не нужно. Прогресс сборки и логи видны в кабинете в реальном времени.

  5. Проверьте API и автодокументацию#

    Когда сборка завершится, в кабинете появится публичная ссылка с HTTPS. FastAPI отдает интерактивную автодокументацию по пути /docs — откройте ее в браузере, чтобы увидеть все эндпоинты и тут же отправить тестовые запросы. Если API ответил, значит он работает.

Готово: ваш API на FastAPI доступен в интернете по защищенной ссылке без собственного сервера и настройки nginx. На бесплатном тарифе веб-приложение засыпает при простое и просыпается по первому запросу — он приходит чуть медленнее, зато проект ничего не стоит в простое. Если API должен отвечать мгновенно и без пауз, подойдет платный тариф с постоянной работой. При сбое Netrun перезапускает проект сам, а логи и статус всегда видны в кабинете. Попробовать Netrun.

Частые вопросы

Как запустить uvicorn, чтобы он взял порт из окружения?

Например, командой uvicorn main:app --host 0.0.0.0 --port $PORT или прямо из кода: uvicorn.run(app, host="0.0.0.0", port=int(os.environ.get("PORT", 8000))). Главное — не 127.0.0.1: такой адрес доступен только изнутри сервера, и ссылка снаружи не откроется.

Почему по ссылке ошибка, хотя локально API работает?

Чаще всего приложение слушает localhost или жестко прописанный порт. Проверьте, что uvicorn запущен на 0.0.0.0 и берет порт из переменной PORT, а все зависимости перечислены в requirements.txt. Подробности ошибки видны в логах в кабинете.

Можно ли скрыть /docs от посторонних?

Да, это настраивается в самом FastAPI: передайте docs_url=None и redoc_url=None при создании приложения, и страницы документации перестанут открываться. Удобно включать их по переменной окружения — только там, где они нужны.

Где API хранить базу данных?

Если API пишет в SQLite, кладите файл базы в постоянную папку /data: все, что лежит там, переживает обновление кода и перезапуск, а файлы вне /data при следующей публикации пропадают. PostgreSQL можно подключить внешний через строку подключения в секретах или поднять сервисом в своем docker-compose.

Подойдет ли бесплатный тариф для API, к которому обращается фронтенд?

Для учебного проекта или демо — да: API засыпает без запросов и просыпается при первом обращении, просто первый ответ после паузы приходит на несколько секунд позже. Если API должно отвечать мгновенно в любой момент, подойдет тариф Pro, на котором проект не засыпает.

Запустите свой проект

Загрузите код, ответьте на пару вопросов — и получите рабочую ссылку. Есть бесплатный тариф

Попробовать Netrun
Все статьи блога