josevictorp81 / recipeapi

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

recipeapi

API que provê informações sobre receitas gastronômicas. As informções acerca da receitas são: nome da receita, tempo de preparo, preço, link para a receita, usuário que cadastrou a receita, as tags, que são sugestões de qual periodo fazer o seu consumo, e os ingredientes que compõe a receita.

Endpoints

  • Usuário:
api/user/create - criar usuário
api/user/token - criar token de acesso
api/user/me - lista os dados do usuário logado
  • Receita: .
api/recipe/recipes - cria, lista, lista por ID, atualiza (ID) e deleta (ID)
  • Tags:
api/recipe/tags - cria, lista, lista por ID, atualiza (ID) e deleta (ID)
  • Ingredientes:
api/recipe/ingredients - cria, lista, lista por ID, atualiza (ID) e deleta (ID)

Executar

OBS: necessário ter Docker e Docker Compose instalados na sua máquina.

Execute os seguintes comando:

  • Criar imagem docker:
docker-compose build 
  • Executat as migrations:
docker-compose run --rm api python manage.py makemigrations 
docker-compose run --rm api python manage.py migrate 
  • Criar superusuário (Opcional):
docker-compose run --rm api python manage.py createsuperuser
  • Executar aplicação:
docker-compose up
  • Parar aplicação:
docker-compose down
  • Executar testes:
docker-compose run --rm api python manage.py test

Frameworks e Bibliotecas

About

License:MIT License


Languages

Language:Python 99.6%Language:Dockerfile 0.4%