🇺🇸 English

🇧🇷 Português

🍔 CodeBurger Project API

Vídeo   |    Tecnologias   |    Sobre   |    Rotas   |    Middlewares   |    Clone   |    Contato

📹 Apresentação em Vídeo do Projeto

dev-burger-order-log-API-video.mp4

Caso o vídeo apresente algum erro, recarregue a página!
Acesse o projeto online AQUI

🚀 Tecnologias utilizadas

• NodeJS
• ExpressJS
• UUID
• Javascript

📝 Sobre

Assistir o vídeo acima e/ou acessar o projeto online ajudará na compreensão da explicação!

Esse projeto é a API do CodeBurger, uma aplicação Web que realiza o cadastro e a gerência de pedidos de uma hamburgueria, servindo como base para a sua Interface que desenvolvi essencialmente em ReactJS.

📃 Rotas e Exemplos

• POST /order: Essa rota recebe o pedido do cliente, o nome do cliente e o valor do pedido. essas informações são passadas pelo body da requisição, e com base nelas um novo pedido é registrado dentro de um array, no seguinte formato:

  {
    id: "ac3ebf68-e0ad-4c1d-9822-ff1b849589a8",
    order: "X- Salada, 2 batatas grandes, 1 coca-cola",
    clientName:"José",
    price: 44.50,
    status: "Em preparação"
  }

  As informações de id e status são geradas no sistema e incorporadas no pedido. Os ids são gerados fazendo o uso da biblioteca uuid, e o status é sempre de 'Em preparação' quando um pedido é feito.
  Essa rota também tem uma verificação especial para impedir que pedidos com dados incompletos sejam feitos.

• GET /order: Essa rota lista todos os pedidos já feitos, exibindo os que está dentro do array.

• GET /order/:id: Com base no id enviado, essa rota retorna um pedido específico.

• PUT /order/:id: Com base no id enviado, essa rota pode alterar um pedido, podendo ser um, ou todos os dados do pedido (exceto o id e o status, claro).

• PATCH /order/:id: Com base no id enviado, assim que chamada, essa rota altera o status do pedido recebido para "Pronto".

• DELETE /order/:id: Com base no id enviado, assim que chamada, deleta o pedido recebido.

• Ao chamar a rota POST /order passando { order: "X- Salada, 2 batatas grandes, 1 coca-cola", clienteName:"José", price: 44.50 }, o array fica dessa forma:

[
    {
        id: 'ac3ebf68-e0ad-4c1d-9822-ff1b849589a8',
        order: 'X- Salada, 2 batatas grandes, 1 coca-cola',
        clienteName: 'José',
        price: 44.5,
        status: 'Em preparação'
    }
];

• Ao chamar a rota PATCH /order/ac3ebf68-e0ad-4c1d-9822-ff1b849589a8, o array fica dessa forma:

[
    {
        id: 'ac3ebf68-e0ad-4c1d-9822-ff1b849589a8',
        order: 'X- Salada, 2 batatas grandes, 1 coca-cola',
        clienteName: 'José',
        price: 44.5,
        status: 'Pronto'
    }
];

🔑 Middlewares

• checkIdExistence: Sua função é verificar se o ID recebido existe e tomar medidas em caso de inexistência. Ele é usado em todas as rotas que recebem um ID.

• showMethodNUrl: Sua função é mostrar no console o método(GET,POST,PUT,DELETE, etc) e também a url da requisição. Ele é usado em todas as requisições e tem o objetivo apenas de facilitar e organizar o desenvolvimento.

• verifyClientData: Sua função é verificar os dados do cliente enviados pelo body, e tomar medidas caso essa requisição tenha a intenção de modificar dados que o cliente não tem permissão.

📖 Clonando o Projeto

Para clonar e executar este projeto em seu computador, você precisará do Git, Node.js v16.13.2 ou superior, e de preferência, um API Client como o Insomnia (mas também pode ser acessado pelo navegador) previamente instalados.
No terminal:

# Clone esse repositório com:
> git clone https://github.com/Luk4x/dev-burger-order-log-API.git

# Entre no repositório com:
> cd dev-burger-order-log-API

# Instale as dependências com: 
> npm i

# Execute o projeto com:
> npm run server

# Feito isso, você já poderá acessar o projeto pelo link que aparecerá no terminal! (algo como http://localhost:3000/ ou http://127.0.0.1:5173/)

🤝 Contato dos Contribuintes

Vitrine.Dev 🪟 Lucas Maciel 🪧 Vitrine.Dev Lucas Maciel ✨ Nome 🍔 CodeBurger API 🏷️ Tecnologias nodejs, expressjs, javascript, uuid 📷 Img

Voltar ao Topo