FastAPI Project

Этот проект реализует API с маршрутами для различных задач, таких как вычисление суммы, переворот строки, калькулятор и работа с глобальным списком.

Установка и запуск проекта

Шаг 1: Клонирование репозитория

Клонируйте репозиторий на свой локальный компьютер:

git clone <https://github.com/BakhmetovRustam/api_project
cd api_project

Шаг 2: Создание и активация виртуального окружения

Для изоляции зависимостей проекта создайте и активируйте виртуальное окружение.

• Создание виртуального окружения:

  python -m venv env

• Активация виртуального окружения:

  • Для Windows:

    env\Scripts\activate

  • Для Linux/macOS:

    source env/bin/activate

После активации в командной строке будет отображаться префикс (env).

Шаг 3: Установка зависимостей

Установите зависимости, указанные в файле requirements.txt:

pip install -r requirements.txt

Шаг 4: Запуск приложения

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

uvicorn main:app --reload

После запуска сервер будет доступен по адресу http://localhost:8000.

Шаг 5: Примеры использования API

Вы можете использовать следующие примеры для тестирования API.

• Получить сумму от 1 до n:

  curl http://localhost:8000/sum1n/10

• Получить n-ное число Фибоначчи:

  curl http://localhost:8000/fibo?n=5

• Перевернуть строку, переданную через заголовок:

  curl -X POST -H "string: hello" http://localhost:8000/reverse

• Добавить элемент в список:

  curl -X PUT -d '{"element":"Apple"}' -H 'Content-Type: application/json' http://localhost:8000/list

• Получить список элементов:

  curl http://localhost:8000/list

• Вычислить математическое выражение:

  curl -X POST -d '{"expr": "1,+,1"}' -H 'Content-Type: application/json' http://localhost:8000/calculator

Шаг 6: Отключение виртуального окружения

После завершения работы вы можете отключить виртуальное окружение командой:

deactivate