Estudo documentação com Swagger
Informações
Principais recursos utilizados:
- NodeJS
- Framework Express
- Banco de Dados MongoDB
- Swagger
- yaml
- Mongoose
- bcrypt
- jwt
- docker
Estrutura
O projeto foi estruturado para que seja possível configurar da porta de acesso ao sistema, link de conexão com o banco de dados e url para a busca dos dados no banco MongoDb sem que sejam realizadas grandes alterações no projeto, para isso, deve ser alterado o arquivo 'default.yml' que se encontra na pasta 'config'.
Desenvolvida configuração com a ferramenta Swagger para que sirva de auxilio, teste e documentação do software, sendo possível realizar chamadas às rotas da Api. Sua configuração se da através do arquivo 'swagger.json' que se encontra na raiz do projeto.
As rotas da api foram modularizadas para que possam ser criadas novas rotas/modulos em pastas separadas, estas se encontram na pasta './api/routes' Cada módulo contém seus controllers, services e routes.
Detalhes
- Foi utilizado o banco de dados MongoDB na plataforma MLAB e Mongoose para realizar as ações no banco
- Para proteção das rotas, foi utilizada a biblioteca jwt. Sempre que o usuario realizar o login no sistema, será gerado um token para que o mesmo consiga utilizar o software. As permissões são de acordo com o tipo do usuário (admin ou common)
- Para facilitar alterações como url de banco de dados, token key (utilizado na criação do token do usuário), configuração de porta de acesso a sistema, foi utilizada a biblioteca js-yaml. Com esta biblioteca, estas configurações são realizadas no arquivo config/default.yml
- Para manter a senha do usuário em sigilo, foi utilizada a biblioteca bcrypt para que a senha seja criptografada ao ser criada e registrada no banco de dados.
- Para facilitar a instalação, foi disponibilizado o acesso ao software através do Docker, que consiste em criar e executar um ambiente para a execução do software.
Execução
Opção 1
- docker build -t /queima-diaria .
- docker run -p 3002:3002 -d /queima-diaria
Opção 2
- Para execução do software devem ser instalados NodeJS.
- Após realizar o download do software, na raiz do projeto devem ser executados os comandos:
- npm install
- node server.js
Acesso ao Swagger
- localhost:3002/swagger
Login
- localhost:3002/api/user/signIn
Get Users
- localhost:3002/api/users
Get Movies
- localhost:3002/api/movie