Burger Queen - API REST

Índice

• 1. Resumo do Projeto
• 2. Considerações Técnicas
• 3. Futuras Implantações

---

1. Resumo do Projeto

Esse projeto é uma API REST desenvolvida durante o bootcamp da Laboratória, para introduzir o funcionamento de back-end.

Com o contexto de produzir uma API para um restaurante, por meio dessa API, é possivel interagir com os dados do cardápio e dos pedidos, sendo inicialmente inseridos 5 e 7 dados respectivamente.

2. Considerações Técnicas

A API foi feita com Node.js e o framework do Express, sendo desenvolvido na plataforma Docker.

Foi utilizado o PostgreSQL para gerenciar o banco de dados, por meio do Sequelize, entre outras bibliotecas. Para realização dos testes foi utilizado o Jest e supertest.

2.1 Funcionamento

A aplicação foi hospedada no Heroku e pode ser acessada pelo link https://api-bq.herokuapp.com

Temos os endpoints dos itens do cardápio (products) e dos pedidos (orders).

As requests disponíveis são as seguintes:

/products

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

/orders

• GET /orders
• GET /orders/:orderid
• POST /orders
• PUT /orders/:orderid
• DELETE /orders/:orderid

Obs.: Alguns dados podem ser obrigatórios para poder dar POST.

3. Futuras Implantações

• Endpoint de mesas
• Endpoint de histórico de pedidos
• Endpoint de criação de usuário
• Endpoint de alteração de usuário
• Endpoint de exclusão de usuário
• Autenticação com JSON Web Token (JWT)
• Acrescentar níveis de permissão de usuário
• Testes e2e