Запуск FastAPI приложения

Вспомогательная задача

Пользователь спрашивает, как запустить код FastAPI, а я объясняю, как использовать румовые маршруты и асинхронные функции для серверных запросов.

Проверяю установку

Сначала устанавливаю FastAPI и Uvicorn с помощью pip, затем сохраняю код в файл main.py.

Чтобы запустить этот код с использованием FastAPI, выполните следующие шаги:

1. Установите FastAPI и Uvicorn (ASGI-сервер для запуска приложения):

   pip install fastapi uvicorn
   

2. Сохраните ваш код в файл с именем main.py.

3. Запустите приложение с помощью Uvicorn:

   uvicorn main:app --reload
   

   • Здесь main — это имя файла без расширения .py.
   • app — это экземпляр FastAPI в вашем коде.
   • Флаг --reload позволяет автоматически перезагружать сервер при изменении кода (удобно для разработки).

4. Откройте браузер и перейдите по следующим адресам, чтобы проверить работу API:

   • Главная страница: http://127.0.0.1:8000/ — вы должны увидеть сообщение "Hello!".
   • Эндпоинт /posts: http://127.0.0.1:8000/posts — вы получите JSON с постами.

5. Просмотр документации:

   • FastAPI автоматически генерирует интерактивную документацию Swagger UI по адресу http://127.0.0.1:8000/docs.
   • Альтернативная документация ReDoc доступна по адресу http://127.0.0.1:8000/redoc.

Пример структуры файлов:

- ваш_проект/
  - main.py

Пример содержимого main.py:

from fastapi import FastAPI

app = FastAPI()

@app.get("/")
def get_index():
    return "Hello!"

@app.get("/posts")
async def get_posts():
    return {"posts": ["Hello world!", "Some other post"]}

Дополнительные советы:

• Убедитесь, что у вас установлена последняя версия Python (рекомендуется Python 3.7 или выше).
• Если вы используете виртуальное окружение, активируйте его перед установкой пакетов и запуском приложения.

Команды для виртуального окружения (необязательно):

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

   python -m venv venv
   

2. Активируйте виртуальное окружение:

   • На Windows:

     venv\Scripts\activate
     

   • На Linux/Mac:

     source venv/bin/activate
     

3. Далее устанавливайте пакеты и запускайте приложение как обычно.

Надеюсь, это поможет вам запустить ваше FastAPI приложение!