Skip to content

Servidor web que serve JSON através de uma conexão HTTP, criando usando MVC.

Notifications You must be signed in to change notification settings

juhsolano/Beer-Queen-API

 
 

Repository files navigation

BEER QUEEN - API

"Burger Queen" refere-se ao projeto desenvolvido durante o bootcamp da Laboratória, que tinha por obejtivo o aprendizado a construção de um servidor web, capaz de manejar as requisições que lhe são enviadas, devolvendo respostas ao cliente.


Índice

  1. Resumo do Projeto
  2. Como Usar
  3. Tecnologias Envolvidas

1. Resumo do Projeto

"Beer Queen" é o servidor web que pode ser futuramente implementa ao restaurante "God Save the Queen - Burger & Beer". O projeto consiste em um servidor web capaz de "ouvir" o que acontece em uma aplicação através de uma porta de rede, pela qual é possível enviar as requests (requisições) e obter responses (respostas), seguindo o modelo de arquitetura MVC (Model View Controller). O projeto foi desenvolvido partindo de um boilerplate fornecido que continha a estrutura básica.


2. Como Usar

Dentro da pasta do projeto e tendo-se o NodeJs e Docker devidamente instalados é possível subir a aplicação através do comando:

docker-compose up <ambiente>

Podendo ser os ambientes: db, dev ou test (para rodar os testes de integração). A aplicação se encontra hospedada no Heroku.

As requisições podem ser executadas através dos endpoints:

HTTP API

__/product__

  • GET /product
  • GET /product/:productid
  • POST /product
  • PUT /product/:productid
  • DELETE /product/:productid

__/order__

  • GET /order
  • GET /order/:orderid
  • GET /order/itens
  • GET /order/itens/itens:id
  • GET /order/item/item:id
  • POST /order
  • POST /order/itens
  • PUT /order/:orderid
  • PUT /order/itens/itens:id
  • DELETE /order/:orderid
  • DELETE /order/itens/:itensid

__/table__

  • GET /table
  • GET /table/:tableid
  • POST /table
  • PUT /table/:tableid
  • DELETE /table/:tableid

Exemplo de requisição:

Para acessar a lista de produtos disponíveis no estabelecimento basta acessar:

https://beer-queen.herokuapp.com/api/product

E para acessar um produto específico, basta acrescentar o id:

https://beer-queen.herokuapp.com/api/product/4

beer_queen

Figura 1. Banco de dados sendo populado através do Postman.


3. Tecnologias e Ferramentas Envolvidas

Para o desenvolvimento do projeto foram utilizados:

  • NodeJs
  • Docker
  • Express
  • Sequelize
  • PostgreSQL (por meio do dBeaver)
  • Mocha & Chai
  • Postman
  • Heroku

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 100.0%