Este repositório contém um projeto que me foi dado pela BeMobile como um teste para uma oportunidade de trabalho. Em resumo, eu deveria criar uma API com algumas especificações que me foram passadas.
Para este projeto, eu usei Node js com Adonis js e Javascrip para o backend, além de MySQL com Lucid para o banco de dados.
Para o projeto rodar na sua máquina, você vai precisar ter instalado:
- npm ou outro pacote similar - Eu recomendo a versão 10.2.3
- Node.js - Eu recomento a versão 18.19.0 'Hydrogen' (LTS)
Primeiro de tudo, clone este repositório usando a opção SSH com o comando:
git clone git@github.com:pedrohassen/bemobile-api.gitEntre na pasta 'be-api' com o comando:
cd be-api/Instale todas as dependências:
npm iRode o docker-compose para instalar o MySQL com as configurações necessárias:
docker-compose upModifique o arquivo .env.example para que ele se torne .env e mude as variáveis de ambiente de acordo com a necessidade, Após isso, abra por exemplo, o MySQL Workbench e crie manualmente a table 'adonis':
CREATE DATABASE IF NOT EXISTS adonis;Inicie o server com:
npm start ou node server.jsFaça as migrations necessárias com:
adonis migrations:runE após isso é só começar a utilizar as rotas conforme necessidade.
http://localhost:3333/Olá Mundo! BeMobile API - Desafio Backend. Rota inicial de introdução, criada manualmente.
Output:
{"greeting":"Hello World: BeMobile - Desafio Backend"}http://localhost:3333/userEsta rota possibilita o registro de um usuário no banco de dados.
Input:
{
"username": "User",
"email": "user@email.com",
"password": "1234"
}Output:
{
"username": "User",
"email": "user@email.com",
"password": "$2a$10$Mhs5sn1eeFzDKs6DAJ8FCu6xDmCa1lMLqipgXtwAAoiUqvBj4BYci",
"created_at": "2024-01-26 00:08:55",
"updated_at": "2024-01-26 00:08:55",
"id": 1
}Como pode ver, o password é registrado encriptado.
http://localhost:3333/loginEsta rota realiza o login do usuário após a sua criação.
Input:
{
"email": "user@email.com",
"password": "1234"
}Output:
{
"type": "bearer",
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1aWQiOjEsImlhdCI6MTcwNjIzODY3OX0.kvRJoph0Jiyja8itPRhRNwFkrVxYfj10CxjW3ZI7rXM",
"refreshToken": null
}É gerado um token, que deve ser utilizado para validar o login do usuário cadastrado. Ele deve ser inserido no campo 'Auth', sub-seção 'Bearer'. Ou usado de forma lógica pelo frontend, afim de validar o usuário que faz o login de forma correta.
http://localhost:3333/bookEsta rota cadastra um livro no banco de dados. Para que funcione, é necessário o login de um usuário com token validado.
Input:
{
"title": "Livro Exemplo",
"author": "Autor Exemplo",
"description": "A jornada exemplar",
"price": 55,
"stock": 50,
"year": 2024
}Output:
{
"title": "Livro Exemplo",
"author": "Autor Exemplo",
"description": "A jornada exemplar",
"price": 55,
"stock": 50,
"year": 2024,
"created_at": "2024-01-26 00:17:28",
"updated_at": "2024-01-26 00:17:28",
"id": 1
}http://localhost:3333/booksEsta rota busca todos os livros cadastrados no banco de dados e os mostra em um array.
http://localhost:3333/book/:idEsta rota busca um livro específico, o encontrando pelo ID ao qual foi registrado.
http://localhost:3333/book/:idEsta rota atualiza as informações do livro, é necessário que o output seja semelhante ao da rota que registra os livros. É necessário o login de um usuário com token validado.
http://localhost:3333/book/:idEsta rota deleta um livro, sem realmente o deletar do banco de dados. Na criação do livro, existe um atributo chamado 'active' que é por padrão setado para ser 1. Quando esta rota é usada, este atributo é mudado para 0, significando que não está mais disponível para a venda. Mas sem deletar as informações do bando de dados, caso no futuro ele volte à venda. É necessário o login de um usuário com token validado.
http://localhost:3333/clientEsta rota cadastra um cliente no banco de dados. É necessário o login de um usuário com token validado.
Input:
{
"name": "Cliente",
"cpf": "55555555555",
"address": "Rua das Palmeiras",
"number": 5555,
"complement": "Esquina Rua Principal",
"city": "Cidade do Cliente",
"neighborhood": "Centro",
"state": "RS",
"country": "Brasil",
"phoneNumber": "55555555"
}Output:
{
"message": "Client created successfully",
"client": {
"id": 1,
"name": "Cliente",
"cpf": "55555555555",
"address": "Rua das Palmeiras",
"number": 5555,
"complement": "Esquina Rua Principal",
"city": "Cidade do Cliente",
"neighborhood": "Centro",
"state": "RS",
"country": "Brasil",
"phoneNumber": "55555555"
}
}http://localhost:3333/clientsEsta rota busca todos os clientes já cadastrados no banco de dados. É necessário o login de um usuário com token validado.
http://localhost:3333/client/:idEsta rota busca um cliente específico pelo seu ID gerado na hora do cadastro. É necessário o login de um usuário com token validado.
http://localhost:3333/client/:idEsta rota atualiza as informações de um cliente buscado pelo ID, menos o cpf, que é imutável. É necessário um input semelhante ao da rota de cadastro de clientes. É necessário o login de um usuário com token validado.
http://localhost:3333/client/:idEsta rota deleta um cliente buscado pelo ID. É necessário o login de um usuário com token validado.
http://localhost:3333/saleEsta rota cadastra a venda de um livro a um cliente específico. É preciso definir o ID do cliente, o ID do livro, a quantidade de livros, a data e a hora da venda. É necessário o login de um usuário com token validado.
Input:
{
"client_id": 1,
"book_id": 1,
"quantity": 2,
"date": "2020-01-01",
"hour": "14:30"
}Output:
{
"message": "Sale registered successfully",
"sale": {
"client_id": 1,
"book_id": 1,
"quantity": 2,
"unity_price": 55,
"total_price": 110,
"date": "2020-01-01",
"hour": "14:30",
"created_at": "2024-01-26 00:37:28",
"updated_at": "2024-01-26 00:37:28",
"id": 1
}
}É importante salientar que, a partir de agora, quando usada a rota que busca um cliente por ID, no registro do cliente, ficarão todas as vendas a ele associadas.
👤 Pedro Hasse Niemczewski
- Github: @pedrohassen
- Linkedin: Pedro Hasse Niemczewski
Dê uma ⭐️ se este projeto te ajudou!