alencartha / Burger-Beef-API

Desenvolvimento de API RESTful, integrada a um banco de dados relacional.

Burger Beef - API

Acesse a API clicando AQUI.

Índice

• 1. Sobre
• 2. API
• 3. Considerações
• 4. Tecnologias Utilizadas
• 5. Desenvolvedora

1. Sobre

A API foi desenvolvida para a aplicação front-end do Burger Beef: um pequeno restaurante de hambúrgueres, que possui uma interface na qual é possível realizar pedidos utilizando um tablet, e enviá-los para a cozinha para que sejam preparados de forma ordenada e eficiente.

2. API

A API Burger Beef contém os seguintes endpoints:

/auth

• POST /auth

/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

3. Considerações:

-> Para os endpoints de /users - exceto metódo POST, /orders e /products, realizei um tratamento no qual só é possível acessá-los se o usuário possuir um Token (este, fornecido no momento em que o usuário é criado).

-> Os Tokens expiram em 24h, mas a cada autenticação do usuário no aplicativo é possível visualizar o Token correspondente à sessão.

4. Tecnologias Utilizadas:

• Node.js
• Express
• Sequelize
• JWT Token
• PostgreSQL
• Dbeaver (visualizar tabelas do banco de dados e suas relações)
• Postman (para teste de requisições)
• Heroku (deploy da API)

5. Desenvolvedora:

Thaís Alencar.