Giter Club home page Giter Club logo

fastapi_restaurant's Introduction

fastapi_restaurant

До начала

Все константы перенесены в .env файл. достаточный для запуска .env загружен в репо.

  • Реализовать вывод количества подменю и блюд для Меню через один (сложный) ORM запрос. - в репозитории menu menu.py - orm_read_menu
  • Реализовать тестовый сценарий «Проверка кол-ва блюд и подменю в меню» из Postman с помощью pytest - сценарий использовался в тестах: test_api_all.py
  • Описать ручки API в соответствий c OpenAPI - openapi.json
  • Реализовать в тестах аналог Django reverse() для FastAPI - conftest.py - функция reverse_url
  • Добавить эндпоинт (GET) для вывода всех меню со всеми связанными подменю и со всеми связанными блюдами. - последний всё в том же репозитории menu.py
  • Фоновая задача: синхронизация Excel документа и БД. - admin_task.py репо к ней:admin.py
  • Доступная наружу папка(имя файла - хардкод) admin
    • настройка этой папки в docker-compose.yaml - docker-compose.yaml в строке 63. Исправить при необходимости напрямую там или переменную в дотЕНВ.

Начало работы

Клонирование репозитория

git clone https://github.com/gramatan/fastapi_restaurant.git

Запуск проекта

Без pytest

  1. Перейдите в директорию проекта и выполните:
docker-compose up

С pytest в отдельном контейнере

  1. Перейдите в директорию проекта и выполните:
docker-compose -f docker-compose-test.yaml up

Результаты тестов будут отображены в консоли.

Примечание: Оба варианта используют одни и те же порты, поэтому при запуске одного из них, другой должен быть остановлен.

Тестирование

Приложение готово к тестированию! Оно доступно на порту 8000. Основной исполняемый файл находится по адресу /app/main.py.

Тесты находятся в директории app/tests.

Все тесты API находятся в test_api_all.py и используют reverse_url() для получения адресов. Все тесты из сценария "Проверка количества блюд и подменю в меню" входят в общий список тестов.

Подсчет количества подменю и блюд без использования полей реализован в menu.py. Он доступен через конечную точку get("/api/v1/menus/ORM/{menu_id}").

openapi.json содержит описание API.

База данных

Вы можете очистить таблицы, запустив файл create_tables.py. По умолчанию база данных пуста и готова к использованию.

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

fastapi_restaurant's People

Contributors

gramatan avatar

Stargazers

Artem Popov avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.