/flask_api

Flask API project

Primary LanguagePython

Проект Flask API

Этот проект представляет собой трекер задач.

Для виртуализации используется Docker и docker-compose. В приложении flask-api используются следующие контейнеры: - my-api - REST API на основе flask, которое реализует CRUD операции с БД. - db - БД PostgreSQL. - swagger-ui. Документация к API.

В базе данных используются две таблицы. 1. Таблица задач (tasks). Имеет следующие колонки: id, название, родительская задача, зависимая задача, исполнитель, срок, статус. 2. Таблица исполнителей (employees). Имеет следующие колонки: id, фамилия, имя, отчество, должность.

Особенности

  • В файле model.py описаны классы таблиц и функции для работы с ними
  • В файле app.py описаны роуты для API
  • Все методы возвращают данные в json формате
  • Для работы с БД используется ORM SQLAlchemy
  • Документация к API создана при помощи swagger

Запуск

Клонируйте репозиторий на компьютер. Перейдите в каталог с проектом. Обновите установщик пакетов pip. Установите зависимости. Собираем сервисы и запускаем.

git clone https://github.com/marcusstill/flask_api.git
cd flask_api
pip install --upgrade pip
pip install -r requirements.txt
docker compose up --build my-api

API

API проекта доступен по адресу http://127.0.0.1:80/ (или 0.0.0.0). Документация к API доступна по следующему адресу: http://localhost:8002/.