🍟🍔 Burger Game - Back-end - API

Índice

• 1. Prefácio
• 2. Resumo do projeto
• 3. Endpoints da API
• 4. Implementações
• 5. Desenvolvedora

1. Prefácio

O restaurante Burger Game , que está crescendo, necessita de um sistema para realizar pedidos usando um tablet, e que os enviem à cozinha para que sejam preparados de forma ordenada e eficiente.

A interface front-end da aplicação Burger Queen já foi criado acesse aqui para conhecer. Com a criação do back-end, temos a facilidade de realizar o manejamento dos dados. Realizado através de uma API rest que e compatível com as requisições vindas do front.

2. Resumo do projeto

Como back-end, nesse caso nos referimos a um servidor web, que é basicamente um programa que ouve o que acontece na aplicação através de uma porta de rede, pela qual podemos enviar requisições (requests) e obter respostas (responses).

Um servidor web deve manejar as requisições que chegam e devolver respostas a elas, que serão enviadas de volta ao cliente. Quando falamos de aplicações de servidor, isso implica uma arquitetura de cliente/servidor, onde o cliente é um programa que faz requisições através de uma rede (por exemplo o navegador, o cURL, etc) e o servidor é o programa que recebe essas requisições e as responde.

3. Endpoints da API

/users

• GET /users
• GET /users/:uid
• POST /users
• PUT /users/:uid
• DELETE /users/:uid

/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

4. Implementações

Como implentação futura, pretendo realizar o desenvolvimento:

• Middleware de erros
• Outros endpoints
• Criar a documentação da API
• Testes unitários para cada função
• Testes "end to end" ou e2e (de uma ponta a outra)

5. Desenvolvedora

Este projeto foi desenvolvido * Luciana Pereira .