Olá dev tudo bem? Este é o 4º Desafio da 5º Sprint do programa de bolsas NodeJs, onde foi realizado um aplicação API REST FULL, com os conhecimentos adquiridos pelos instrutores do programa, a cada sprint realizada e os recursos fornecidos pelo programa.
"Olá bom dia, gostaria de solicitar um sistema para abertura da minha locadora de carros. Ela se chama "compassolisa" e atuamos no seguimento de aluguel de carro de luxo e semi luxo. Trabalhamos com carros exclusivos ou seja não temos mais de um modelo de carro disponível por cidade. Já temos o nosso Front-end pronto, porem estamos necessitando o Back-end, por isso contatamos vocês para desenvolver nosso Back-end, dado ao nosso front. Iremos atuar em 3 etapas e dependendo de como for a primeira fecharemos o contrato da segunda e a terceira etapa. Nesta primeira etapa nos pensamos em criar os registros de carros, usuários e a autenticação."
Para obter o projeto em sua máquina local
- Utilizando o git bash
# execute esse comando
git clone https://github.com/washington-wj/api-compassolisa.gitPara rodar a aplicação é necessario fazer algumas configurações
- Anexar o arquivo .env com as seguintes instruções
# Porta a ser utilizada no servidor
PORT_SERVER=3000
# Driver do banco de dados utilizado
DB_DRIVE=mongodb+srv
# Hostname do banco de dados utilizado
DB_HOST=localhost
# Porta local do banco de dados
DB_PORT=27017
# Usuario ADM do banco de dados
DB_USER=admin
# Senha criada no banco de dados
DB_PASS=admin
# Nome do banco de dados criado
DB_DATABASE=compassolisa
# Ou passando tudo em uma chave só
MONGODB_LOCAL_KEY=mongodb://localhost:27017/compassolisa- Adicionar a dependencias NPM
# Execute esse comando para iniciar o pacote npm
npm init -y
# Instalar a biblioteca express
npm install express
# Rodando a aplicaçao
npm run devAplicando Rotas
UTILIZANDO O POSTMAN OU INSOMNIA
- Car 🚘
| Action | URI | Verb HTTP | Endepoint |
|---|---|---|---|
| ↪️ | /api/v1/car | GET | Listar Carro |
| ↪️ | /api/v1/car/:id | GET | Consultar um Carro |
| ➕ | /api/v1/car | POST | Cadastrar Carro |
| ♻️ | /api/v1/car/:id | PUT | Atu 7101 alizar Carro |
| ❌ | /api/v1/car/:id | DELETE | Deletar Carro |
- User 👥
| Action | URI | Verb HTTP | Endepoint |
|---|---|---|---|
| ↪️ | /api/v1/user | GET | Listar Usuarios |
| ➕ | /api/v1/user | POST | Cadastrar Usuario |
| ↪️ | /api/v1/user/:id | GET | Consultar o Usuario |
| ♻️ | /api/v1/user/:id | PUT | Atualizar Usuario |
| ❌ | /api/v1/user/:id | DELETE | Deletar Usuario |
- Rental 🏷️
| Action | URI | Verb HTTP | Endepoint |
|---|---|---|---|
| ↪️ | /api/v1/rental | GET | Listar Locadoras |
| ➕ | /api/v1/rental | POST | Cadastrar Locadora |
| ↪️ | /api/v1/rental/:id | GET | Consultar a Locadora |
| ♻️ | /api/v1/rental/:id | PUT | Atualizar Locadora |
| ❌ | /api/v1/rental/:id | DELETE | Deletar Locadora |
UTILIZANDO O DOCUMENTO SWAGGER
- Documentação Swagger
| Action | URI |
|---|---|
| 📁 | /api-docs |
Para testar a uma rota pelo jest
# utilize esse comando
npx jest --watchAll
| Softwares |
|---|
Postman |
Visual Code |
MongoDB |
NodeJs |
Bruna Santos
Diego Bueno
Felipe Silva
Gabriel Missio
Giovanni Hoffmann
Thais Nicodemus
Washington jose
MIT