/Amassa_API

Projeto Nodejs - Criação de API com modelagem de dados voltadas à um restaurante.

Primary LanguageJavaScript

alt ou título da imagem alt ou título da imagem

Amassa API


Badge em Desenvolvimento

PRs Welcome

GitHub Org's stars GitHub forks

GitHub branches


As dependências utilizadas no projeto foram:

  • alt ou título da imagem
  • alt ou título da imagem
  • alt ou título da imagem
  • alt ou título da imagem
  • alt ou título da imagem

🏃 Iniciando o projeto

Recomendamos que faça o download do Insomnia na sua maquina!

Clone este repositório em sua máquina

$ git clone https://github.com/matgermano/Amassa_API.git

📋 Pré-requisitos para instalação

  1. Instale NodeJS em seu computador. Baixe os arquivos do repositório Amassa aqui no GitHub.

  2. Crie um banco de dados no sistema SQL de sua preferência: MySQL, Postegree, SQL Server, SQLITE3.

  3. Crie uma tabela com o nome amassa no banco de sua preferência.

  4. Instale via terminal utilizando os seguintes comandos:

 npm init
 npm install -g
 npm install express 
 npm install mysql2 
 npm install sequelize sequelize-cli path 
 npm install cors
 npm install --save-dev nodemon

no cmd, terminal ou powershell para rodar o amassa api:

"scripts": {
    "start": "nodemon src/index.js",
    "test": "echo "Error: no test specified" && exit 1"
  }
"scripts": {
    "start": "nodemon src/index.js"
      }
  • abrindo o insomnia você verá algo do tipo:
filter + v
  • clique no sinal de soma ( + )
  • escolha -> new request
  • você vera algo parecido com o exemplo abaixo:
name ( defaul to your request url if left empty )
my request get
create
  • clicando em get você poderá escolher qualquer um entre os quais usamos nessa livraria
  • get
  • post
  • put
  • delete
  • vamos usar o get primeiro depois é só clicar em create

usando o get

agora você deve estar vendo algo do tipo

get https://api.myproduct.com/v1/users send
body
  • clique em body e escolha o json
  • para fazer a consulta dos autores que existem, cole em cima dessa url o link abaixo e clique no send
http://localhost:3000/pratos_principais 
  • o resultado deve ser algo do tipo
[
  {
    "id": 1,
    "nome": "lasanha bolonhesa",
    "ingredientes": "Ragu de carne, molho de tomate, parmesão e muçarela gratinada.",
    "porcao":"Para dividir"
    "preco":"R$60,00"
    "createdat": "2021-11-29t00:58:06.380z",
    "updatedat": "2021-11-29t00:58:06.380z"
  },
]
  • para fazer a consulta de um prato existente
http://localhost:3000/pratos_principais/1 ou 2
  • note que o numero 1 ou 2 é o id do nome

usando o post

agora você sabe quais pratos existem, vamos por mais no registro??

  • para inserir um novo prato, a rota é o mesmo link
http://localhost:3000/pratos_principais
  • dentro do insomnia, abaixo do json vamos colar esse novo prato principal:
{
"nome": "risoto tropical",
"ingredientes": "Salmão grelhado com risoto de limão siciliano."
}
  • você deve ter visto ao lado algo assim:
{
  "id": 2,
  "nome": "risotW tropical",
  "ingredientes": "Salmão grelhado com risoto de limão siciliano",
  "updatedat": "2021-11-29t06:54:26.630z",
  "createdat": "2021-11-29t06:54:26.630z"
}

opa! acho que errei o nome do prato

vamos atualizar!?

usando o put

  • vamos pegar o id do autor que queremos atualizar?
http://localhost:3000/pratos_principais/2
  • agora acredito que está certo:
{
"nome": "risoto tropical",
"ingredientes": "Salmão grelhado com risoto de limão siciliano"
}

Mas e se quiser deletar uns pratos que já saíram do restaurante?

usando o delete

não vamos deletar o risoto vamos precisar dele mais pra frente!

mesma etapa mas o metodo é delete.

  • rota para apagar o prato e clique no send
localhost:3000/pratos_principais/1 ou 2
  • cuidado, tenha certeza que você vai apagar o prato correto!

vamos ver quais nomes existem no registro??

vamos usar o metodo get e a rota é o link abaixo

localhost:3000/nome
  • deve ver algum resultado assim
[
  {
    "id": 1,
    "nome": "lasanha bolonhesa",
    "createdat": "2021-11-29t00:45:29.254z",
    "updatedat": "2021-11-29t00:45:29.254z"
  },
  {
    "id": 2,
    "nome": "risoto tropical",
    "createdat": "2021-11-29t00:45:42.407z",
    "updatedat": "2021-11-29t00:45:42.407z"
  },
  {
    "id": 3,
    "nome": "nhoque da mama",
    "createdat": "2021-11-29t00:45:49.266z",
    "updatedat": "2021-11-29t00:45:49.266z"
  },
]
  • grave os Ids dos nomes dos pratos, vamos precisar

Usando o post

  • Link para o post é o msm do anterior mas o metodo é post
localhost:3000/ingredientes
  • E vamos adicionar um ingrediente!
{
 "ingrediente": "Nhoque com molho branco ou vermelho."
}
  • Você deve ver algo do tipo
{
  "id": 4,
  "ingrediente": "Nhoque com molho branco ou vermelho.",
  "updatedat": "2021-11-29t07:36:27.141z",
  "createdat": "2021-11-29t07:36:27.141z"
}

E se for preciso atualizar algum campo? Para isso usaremos o método:

put

  • rota para atualizar
localhost:3000/ingredientes/4
  • Agora sim!
	{
		"ingredientes": "Calabresa, parmesão, gema de ovo e pimenta do reino."
	}

Usando o delete

eu não sou muito fã de risoto

então vamos deletar ele!

localhost:3000/pratos_principais/2
  • ok, o risoto foi deletado

Agora vamos ver os pratos!!

Usando o get

  • rota para pegar um prato existente
localhost:3000/pratos-principais/1
  • o resultado deve ser esse
    "id": 1,
    "nome": "lasanha bolonhesa",
    "ingredientes": "Ragu de carne, molho de tomate, parmesão e muçarela gratinada.",
    "porcao":"Para dividir"
    "preco":"R$60,00"
    "createdat": "2021-11-29t00:58:06.380z",
    "updatedat": "2021-11-29t00:58:06.380z"
  },
}

Bom! Agora que já sabemos quais os pratos que existem, eu quero saber, como que eu insiro mais livros?

usando o post

  • rota para inserir um novo prato
localhost:3000/pratos
  • prato a ser inserido: lembra que eu disse que usariamos o prato!? Lasanha é o id 1 para mim
{
   "id": 1,
   "nome": "lasanha bolonhesa",
   "ingredientes": "Ragu de carne, molho de tomate, parmesão e muçarela gratinada.",
   "porcao":"Para dividir"
   "preco":"R$60,00"
   "createdat": "2021-11-29t00:58:06.380z",
   "updatedat": "2021-11-29t00:58:06.380z"
}

Vamos atualizar o preço dele então

#usando o put

  • rota para atualizar o prato
localhost:3000/prato_principal
  • Prato com preço atualizado
{
   "id": 1,
   "nome": "lasanha bolonhesa",
   "ingredientes": "Ragu de carne, molho de tomate, parmesão e muçarela gratinada.",
   "porcao":"Para dividir"
   "preco":"R$65,00"
   "createdat": "2021-11-29t00:58:06.380z",
   "updatedat": "2021-11-29t00:58:06.380z"
}

pronto! Agora se quiser, vamos deletar!

usando o delete

  • rota que vamos usar para deletar o prato
localhost:3000/prato_principal/1

Com isso o prato foi deletado!

💻 Equipe de Desenvolvedores

💻 Matheus Germano - Linkedin

💻 Camila Rangel - Linkedin

💻 Israel Marques - Linkedin

💻 Gabriel Bastos - Linkedin

💻 Rafael Soares - Linkedin