ApiRestAdonisJs

Uma API RESTful para Registro de Usuários e Autenticação

Descrição Este projeto é uma API RESTful construída com o framework AdonisJS para o registro de usuários e autenticação. Ele fornece um mecanismo seguro para que os usuários se registrem, autentiquem e acessem recursos protegidos por token.

Funcionalidades

Registro de Usuários com Senha Criptografada
Autenticação de Usuários com Token
Recursos Protegidos por Token
CRUD de Clientes (Rotas Protegidas)
CRUD de Vendas (Rotas Protegidas)
CRUD de Produtos (Rotas Protegidas)

Tecnologias Utilizadas

AdonisJS
MySQL (Banco de Dados)
Docker (Para Ambiente de Desenvolvimento)
MySQL Workbench (Interface gráfica para banco de dados)

Documentação do AdonisJS

Você pode encontrar a documentação oficial do AdonisJS aqui.

Pré-requisitos

Node.js (Versão 18.0.0)
npm (Gerenciador de Pacotes)
Docker (Para Ambiente de Desenvolvimento)
MySQL Workbench (Interface gráfica para banco de dados)

Instalação

Clone este repositório:

git clone git@github.com:luishrs/ApiRestAdonisJs.git

Navegue até o diretório do projeto:

cd ApiRestAdonisJs

Antes de começar, seu docker-compose precisa estar na versão 1.25 ou superior.

Renomear arquivo "`.env.example`" para "`.env`"

Instale as dependências

npm install

Iniciar o serviço de back-end

npm run dev

Iniciar o docker do banco de dados, abra outro terminal e execute o comando.

docker-compose up -d

Conectando ao Banco de Dados

Para interagir e gerenciar seus dados de forma visual, você pode usar uma aplicação de interface gráfica de banco de dados de sua escolha. Recomendamos o uso da extensão "MySQL" para o Visual Studio Code, que oferece funcionalidades poderosas e é uma opção conveniente para desenvolvedores que já estão familiarizados com o ambiente do VS Code.

No entanto, se você preferir usar uma aplicação independente, existem várias opções populares disponíveis:

MySQL Workbench: Uma aplicação oficial da Oracle para gerenciar bancos de dados MySQL. Você pode baixá-la aqui.
DBeaver: Uma ferramenta de banco de dados universal que suporta vários sistemas de gerenciamento de bancos de dados, incluindo MySQL. Você pode baixá-la aqui.
phpMyAdmin: Uma aplicação web para gerenciar bancos de dados MySQL. É acessível através de um navegador. Você pode instalá-lo seguindo as instruções disponíveis aqui.

Escolha a aplicação que melhor se adapte às suas necessidades e preferências. Depois de instalá-la, você poderá usar a interface gráfica para conectar-se ao seu banco de dados, criar tabelas, inserir dados e realizar outras tarefas de gerenciamento.

Lembre-se de configurar a conexão com o banco de dados `usuário: root`, `password: betest`, demais informações são fornecidas no arquivo `.env` do projeto.

Execute o comando npm run prestart realiza várias etapas essenciais para a inicialização do projeto, a configuração do ambiente, a execução das migrações de banco de dados e a inserção de dados fictícios no banco .

npm run prestart

Testando a API

Para testar a API e realizar solicitações, recomendamos o uso de uma ferramenta de cliente HTTP, como o Insomnia ou o Thunder Client. Você pode escolher qualquer uma dessas ferramentas para começar a fazer solicitações à API.

Para registrar um usuário, faça uma requisição POST http://localhost:3333/signup com o corpo da seguinte forma:

{
"email": "email@email.com",
"password": "suasenha"
}

O retorno será no seguinte formato.

{
  "email": "seuemail@email.com",
  "password": "$scrypt$n=16384,r=8,p=1$WC/B3zZ0m6uG7QKwikad2A$NfyLulR3+DRLJIkSrABKtkjc4XbCgrOXw5K0QIJTWZ67m850Crtg27U8KGX9DgurgnMAhCIvuf02aKd3tFQhXQ",
  "created_at": "2023-10-13T15:49:34.835-03:00",
  "updated_at": "2023-10-13T15:49:34.837-03:00",
  "id": 2
}

Autenticação de Usuários após o Endpoint: POST http://localhost:3333/login

Para autenticar um usuário, faça uma requisição POST com o corpo da seguinte forma:

{
"email": "email@email.com",
"password": "suasenha"
}

A resposta incluirá um token de autenticação.

{
  "message": "user successfully logged in",
  "token": {
    "type": "bearer",
    "token": "Ng.7EhvXVHCHs_-zijYyrDx0fVbbv6BIdsv2Gi0Mtbn4HnHP_sLG1vJ6bsA9prJ"
  }
}

Acesso a Recursos Protegidos

As seguintes rotas são protegidas e requerem autenticação por meio do token recebido após o login, que deve ser incluído no cabeçalho de autenticação (Auth) com o tipo "Bearer" para ser autorizado:

/clients: Permite operações CRUD (Criar, Ler, Atualizar e Deletar) de Clientes.
/products: Permite operações CRUD de Produtos.
/sales: Permite operações CRUD de Vendas.

Para acessar essas rotas, certifique-se de que o token de autenticação esteja corretamente configurado no cabeçalho de suas solicitações, como no exemplo a seguir:

Rotas

/clients: CRUD de Clientes (Requer Autenticação)

Para simplificar e agilizar o registro de clientes, será necessário apenas nome e cpf do cliente. Entretanto endereço e telefone tabém são criados, mas só poderá ser inserido da rota PUT, faça uma requisição POST http://localhost:3333/clients com o corpo da seguinte forma:

{
  "name":"Nome do Cliente",
  "cpf": "12345678963"
}

O retorno será no seguinte formato.

 {
  "message": "Client successfully registered",
  "data": {
    "name": "Nome do Cliente",
    "cpf": "12345678963",
    "created_at": "2023-10-13T16:46:52.878-03:00",
    "updated_at": "2023-10-13T16:46:52.878-03:00",
   }
 }

A rota GET/clients ou GET http://localhost:3333/clientes, retorno será no seguinte formato.

[
  {
    "id": 1,
    "name": "Nome do Cliente 1 ",
  },
    {
    "id": 2,
    "name": "Nome do Cliente 2 ",
  },
  {
    "id": 3,
    "name": "Nome do Cliente 3 ",
  }

]

A rota GET/clients ou GET http://localhost:3333/clientes/:id, retorno será no seguinte formato

[
  {
    "id": 1,
    "name": "cliente10",
    "cpf": "12345678901",
    "created_at": "2023-10-14T18:36:06.000-03:00",
    "updated_at": "2023-10-14T20:19:02.000-03:00",
    "addresses": [
      {
        "id": 1,
        "country": "Pais 3",
        "state": "Estado 3",
        "city": "Cidade 3",
        "neighborhood": "Bairro 1",
        "street": "Rua 1",
        "number": "1",
        "client_id": 1,
        "created_at": "2023-10-14T18:36:06.000-03:00",
        "updated_at": "2023-10-14T20:22:06.000-03:00"
      }
    ],
    "telephones": [
      {
        "id": 1,
        "number": "00000000",
        "client_id": 1,
        "created_at": "2023-10-14T18:36:06.000-03:00",
        "updated_at": "2023-10-14T20:22:06.000-03:00"
      }
    ],
    "sales": [
      {
        "id": 1,
        "client_id": 1,
        "product_id": 1,
        "quantity": 2,
        "unit_price": "10.99",
        "total_price": "21.98",
        "created_at": "2023-10-14T18:36:06.000-03:00",
        "updated_at": "2023-10-14T18:36:06.000-03:00"
      },
      {
        "id": 4,
        "client_id": 1,
        "product_id": 1,
        "quantity": 3,
        "unit_price": "10.99",
        "total_price": "32.97",
        "created_at": "2023-10-14T18:37:37.000-03:00",
        "updated_at": "2023-10-14T18:37:37.000-03:00"
      }
    ]
  }
]

A rota PUT http://localhost:3333/clientes/:id, sempre será necessário informar "name" e "cpf" do cliente, e como opcional endereço e/ou telefone, para atualizar as informações cadastradas.

O corpo da requisição ser de 5 formatos, pode ser simples, ou acicionado a chave addess e/ou telephome para atualizar os dados do cliente.

{
  "name":"cliente atualizado",
  "cpf": "12345678901"
}

{
"name": "cliente atualizado ",
"cpf": "78945612325",
"address":{
       "country": "Pais 5",
        "state": "Estado 5",
        "city": "Cidade 5",
        "neighborhood": "Bairro 1",
        "street": "Rua 1",
        "number": "1"
},
"telephone":{
  "number": "999817774"
}
}

{
"name": "cliente atualizado ",
"cpf": "78945612325",
"address":{
       "country": "Pais 5",
        "state": "Estado 5",
        "city": "Cidade 5",
        "neighborhood": "Bairro 1",
        "street": "Rua 1",
        "number": "1"
}
}

{
"name": "cliente atualizado ",
"cpf": "78945612325",
"telephone":{
  "number": "999817774"
}
}

O retorno será no seguinte formato.

{
  "message": "Client successfully updated",
  "client": {
    "id": 1,
    "name": "cliente atualizado",
    "cpf": "12345678901",
    "created_at": "2023-10-14T18:36:06.000-03:00",
    "updated_at": "2023-10-14T20:27:53.113-03:00"
  }
}

A rota DELETE http://localhost:3333/clients/:id, o retorno será no seguinte formato.

{
  "message": "Client successfully deleted",
  "data": {
    "id": 2,
    "name": "Nome do Cliente para deletar",
    "cpf": "85296374147",
    "created_at": "2023-10-13T17:02:07.000-03:00",
    "updated_at": "2023-10-13T17:02:07.000-03:00"
  }
}

/products: CRUD de Produtos (Requer Autenticação)

Para registrar um produto, vale ressaltar que a tabela de produtos interage com a tabela de vendas, para controlar sua quantidade em estoque. Faça uma requisição POST http://localhost:3333/products com o corpo da seguinte forma:

{
  "name": "Livro Novo",
  "author": "autor 2",
  "editor":"editora 2",
  "price": 8.99,
  "stock" :10
}

O retorno será no seguinte formato.

{
  "name": "Livro Novo",
  "author": "autor 2",
  "editor": "editora 2",
  "price": 8.99,
  "stock": 10,
  "created_at": "2023-10-14T20:38:47.378-03:00",
  "updated_at": "2023-10-14T20:38:47.379-03:00",
  "id": 5
}

Para listar todos os produtos, faça uma requisição GET http://localhost:3333/products ou GET http://localhost:3333/products/:id, o retorno será no seguinte formato, sendo ordenado pelo nome, em ordem alfabética.

[
  {
    "id": 5,
    "name": "Livro Novo"
  },
  {
    "id": 1,
    "name": "Produto 1"
  },
  {
    "id": 2,
    "name": "Produto 2"
  },
  {
    "id": 3,
    "name": "Produto 3"
  }
]

Para listar um produto especifico, faça uma requisição GET http://localhost:3333/products/:id, o retorno será no seguinte formato., com todas especificações do produto.

{
  "id": 1,
  "name": "Produto 1",
  "author": "Autor 1",
  "editor": "Editora 1",
  "price": "10.99",
  "stock": 10,
  "created_at": "2023-10-15T12:26:08.000-03:00",
  "updated_at": "2023-10-15T12:26:08.000-03:00"
}

Para atualizar um produto, faça uma requisição PUT http://localhost:3333/products/:id com o corpo da seguinte forma:

{
  "name": "Livro 2 atualizado",
  "author": "autor 2 atualizado",
  "editor":"editora 2 atualizado",
  "price":3.99,
  "stock": 10
}

o retorno será no seguinte formato.

{
  "id": 3,
  "name": "Livro 2 atualizado",
  "author": "autor 2 atualizado",
  "editor": "editora 2 atualizado",
  "price": 3.99,
  "stock": 10,
  "created_at": "2023-10-13T17:12:47.000-03:00",
  "updated_at": "2023-10-13T17:14:57.886-03:00"
}

Para deletar um produto, faça uma requisição DELETE http://localhost:3333/products/:id com o corpo da seguinte forma:

{
  "message": "Product deleted",
  "product": {
    "id": 5,
    "name": "Livro para ser deletado",
    "author": "autor ",
    "editor": "editora",
    "price": 6.99,
    "stock": 10,
    "created_at": "2023-10-13T17:23:36.000-03:00",
    "updated_at": "2023-10-13T17:23:36.000-03:00"
  }
}

/sales: CRUD de Vendas (Requer Autenticação)

Para Criar uma venda, a quantidade em estoque e o valor total é feito dinamicamente, faça uma requisição POST http://localhost:3333/sales com o corpo da seguinte forma:

{
  "client_id":1,
  "product_id":1,
  "quantity":2
}

o retorno será no seguinte formato.

{
  "client_id": 1,
  "product_id": 1,
  "quantity": 2,
  "unit_price": 10.99,
  "total_price": 21.98,
  "created_at": "2023-10-14T20:47:52.394-03:00",
  "updated_at": "2023-10-14T20:47:52.394-03:00",
  "id": 4
}

Para listar todas as vendas, faça uma requisição GET http://localhost:3333/sales, o retorno será no seguinte formato.

[
  {
    "id": 1,
    "client_id": 1,
    "product_id": 1,
    "quantity": 2,
    "unit_price": "10.99",
    "total_price": "21.98",
    "created_at": "2023-10-14T18:36:06.000-03:00",
    "updated_at": "2023-10-14T18:36:06.000-03:00",
    "client": {
      "id": 1,
      "name": "cliente atualizado",
      "cpf": "12345678901",
      "created_at": "2023-10-14T18:36:06.000-03:00",
      "updated_at": "2023-10-14T20:27:53.000-03:00"
    },
    "product": {
      "id": 1,
      "name": "Produto 1",
      "author": "Autor 1",
      "editor": "Editora 1",
      "price": "10.99",
      "stock": 5,
      "created_at": "2023-10-14T18:36:06.000-03:00",
      "updated_at": "2023-10-14T18:36:06.000-03:00"
    }
  },
  {
    "id": 2,
    "client_id": 2,
    "product_id": 2,
    "quantity": 3,
    "unit_price": "12.99",
    "total_price": "38.97",
    "created_at": "2023-10-14T18:36:06.000-03:00",
    "updated_at": "2023-10-14T18:36:06.000-03:00",
    "client": {
      "id": 2,
      "name": "Cliente 2",
      "cpf": "23456789012",
      "created_at": "2023-10-14T18:36:06.000-03:00",
      "updated_at": "2023-10-14T18:36:06.000-03:00"
    },
    "product": {
      "id": 2,
      "name": "Produto 2",
      "author": "Autor 2",
      "editor": "Editora 2",
      "price": "12.99",
      "stock": 7,
      "created_at": "2023-10-14T18:36:06.000-03:00",
      "updated_at": "2023-10-14T18:36:06.000-03:00"
    }
  },
  {
    "id": 3,
    "client_id": 3,
    "product_id": 3,
    "quantity": 1,
    "unit_price": "9.99",
    "total_price": "9.99",
    "created_at": "2023-10-14T18:36:06.000-03:00",
    "updated_at": "2023-10-14T18:36:06.000-03:00",
    "client": {
      "id": 3,
      "name": "Cliente 3",
      "cpf": "34567890123",
      "created_at": "2023-10-14T18:36:06.000-03:00",
      "updated_at": "2023-10-14T18:36:06.000-03:00"
    },
    "product": {
      "id": 3,
      "name": "Produto 3",
      "author": "Autor 3",
      "editor": "Editora 3",
      "price": "9.99",
      "stock": 10,
      "created_at": "2023-10-14T18:36:06.000-03:00",
      "updated_at": "2023-10-14T18:36:06.000-03:00"
    }
  },
  {
    "id": 4,
    "client_id": 1,
    "product_id": 1,
    "quantity": 3,
    "unit_price": "10.99",
    "total_price": "32.97",
    "created_at": "2023-10-14T18:37:37.000-03:00",
    "updated_at": "2023-10-14T18:37:37.000-03:00",
    "client": {
      "id": 1,
      "name": "cliente atualizado",
      "cpf": "12345678901",
      "created_at": "2023-10-14T18:36:06.000-03:00",
      "updated_at": "2023-10-14T20:27:53.000-03:00"
    },
    "product": {
      "id": 1,
      "name": "Produto 1",
      "author": "Autor 1",
      "editor": "Editora 1",
      "price": "10.99",
      "stock": 5,
      "created_at": "2023-10-14T18:36:06.000-03:00",
      "updated_at": "2023-10-14T18:36:06.000-03:00"
    }
  }
]

Para filtrar uma venda pelo ano/mês, faça uma requisição GET http://localhost:3333/sales nesse formato:
http://localhost:3333/sales/filter?year=2023&month=1 onde o mês e anos foram descritos, o retorno será no seguinte formato.

[
  {
    "id": 4,
    "client_id": 1,
    "product_id": 1,
    "quantity": 3,
    "unit_price": "10.99",
    "total_price": "32.97",
    "created_at": "2023-01-14T18:37:37.000-03:00",
    "updated_at": "2023-10-14T18:37:37.000-03:00",
    "client": {
      "id": 1,
      "name": "cliente atualizado",
      "cpf": "12345678901",
      "created_at": "2023-10-14T18:36:06.000-03:00",
      "updated_at": "2023-10-14T20:27:53.000-03:00"
    },
    "product": {
      "id": 1,
      "name": "Produto 1",
      "author": "Autor 1",
      "editor": "Editora 1",
      "price": "10.99",
      "stock": 5,
      "created_at": "2023-10-14T18:36:06.000-03:00",
      "updated_at": "2023-10-14T18:36:06.000-03:00"
    }
  }
]

luishrs/ApiRestAdonisJs

ApiRestAdonisJs

Uma API RESTful para Registro de Usuários e Autenticação

Funcionalidades

Tecnologias Utilizadas

Documentação do AdonisJS

Pré-requisitos

Instalação

Renomear arquivo ".env.example" para ".env"

Conectando ao Banco de Dados

Lembre-se de configurar a conexão com o banco de dados usuário: root, password: betest, demais informações são fornecidas no arquivo .env do projeto.

Testando a API

Acesso a Recursos Protegidos

Rotas

Renomear arquivo "`.env.example`" para "`.env`"

Lembre-se de configurar a conexão com o banco de dados `usuário: root`, `password: betest`, demais informações são fornecidas no arquivo `.env` do projeto.