# Mongo Express

**<span style="color: rgb(34, 34, 34); font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Oxygen, Ubuntu, Roboto, Cantarell, 'Fira Sans', 'Droid Sans', 'Helvetica Neue', sans-serif; font-size: 2.333em;">Interface Mongo Express</span>**

Além da API documentada via Swagger, o backend também conta com uma interface web para gerenciamento direto do banco de dados MongoDB utilizando o **Mongo Express** — uma ferramenta leve e funcional para visualização e execução de comandos no banco de forma gráfica.

---

### **Acesso à Interface Mongo Express**

A interface está disponível no seguinte endereço (ajustável conforme o ambiente de execução):

> 🔗 **[http://localhost:8081](http://localhost:8081/)**

<p class="callout warning">**Lembre-se de ter o projeto rodando no docker para funcionar!**</p>

<p class="callout info">**As credenciais de acesso ao Express são as variáves: <span style="color: rgb(224, 62, 45);">MONGO\_INITDB\_ROOT\_USERNAME </span>e<span style="color: rgb(224, 62, 45);"> MONGO\_INITDB\_ROOT\_PASSWORD </span>dos arquivos env**</p>

Através dela é possível:

- Visualizar todas as coleções disponíveis no banco
- Buscar documentos por filtros (queries MongoDB)
- Editar registros diretamente
- Remover dados manualmente (quando necessário para testes ou administração)
- Inserir novos documentos via interface visual
- Exportar dados para backup ou inspeção

---

### **Utilização no Contexto do Projeto**

A interface do **Mongo Express** é extremamente útil para:

- **Testes de integração e debug** durante o desenvolvimento
- **Administração rápida de dados**, sem a necessidade de linha de comando
- **Verificação de dados persistidos** via requisições realizadas na API
- **Criação manual de documentos**, útil durante o desenvolvimento de novas rotas

---

### **Segurança**

> ⚠️ Em ambiente de produção, o Mongo Express **não deve ser exposto publicamente** sem autenticação e/ou encapsulamento por VPN, proxy ou firewall.  
> No projeto atual, ele é **ativado apenas em ambientes de desenvolvimento**, sem acesso externo.

---

### **Integração com a API**

Durante o desenvolvimento, a interface Mongo Express serve como um complemento ao Swagger:

- Você faz uma requisição no **Swagger UI** (como POST `/api/avaliador/pecas/avaliar`)
- E pode **ver o resultado diretamente no Mongo Express**, conferindo como o documento foi persistido em `coleção: Avaliacao`

Exemplos de coleções visualizáveis:

- `Usuarios`
- `Triagem`
- `Peca`
- `Avaliacao`
- `Recurso`
- `Otps`

---

### **Passo a Passo de Uso**

O mongo express criar algumas tabelas por padrão, mas a que estará sendo usada, é a gerada pelo docker com o nome ***<span style="color: rgb(132, 63, 161);">eclipse,</span>*** como indicado na seta vermelha abaixo, basta clicar em <span style="color: rgb(45, 194, 107);">***View***</span> ou no próprio nome do database:

[![Slide_1.jpg](https://bookstack.ljit.com.br/uploads/images/gallery/2025-05/scaled-1680-/6BI3qutips2KKLC5-slide-1.jpg)](https://bookstack.ljit.com.br/uploads/images/gallery/2025-05/6BI3qutips2KKLC5-slide-1.jpg)

---

Apos clicar no database **eclipse**, temos acesso as *coleções* (entidades do banco), onde cada respectivo dado se encontra, no exemplo abaixo estaremos mostrando a coleção de <span style="color: rgb(45, 194, 107);">***usuários***</span>, mas você pode repetir o mesmo procedimento para as demais entidades:

[![Slide_2.jpg](https://bookstack.ljit.com.br/uploads/images/gallery/2025-05/scaled-1680-/dbg52ZPGnootbfa1-slide-2.jpg)](https://bookstack.ljit.com.br/uploads/images/gallery/2025-05/dbg52ZPGnootbfa1-slide-2.jpg)

---

Depois de abrir a coleção de ***<span style="color: rgb(45, 194, 107);">usuários</span>***, você verá todos os dados cadastrados no banco referentes a essa entidade com todos os campos declarados nas ***Models*** da pasta **api**, como demonstrado abaixo, você pode clicar em cada um dos dados da coleção para abri-la e/ou edita-la:

[![Slide_3.jpg](https://bookstack.ljit.com.br/uploads/images/gallery/2025-05/scaled-1680-/0kuEyY2kBiTnrZV1-slide-3.jpg)](https://bookstack.ljit.com.br/uploads/images/gallery/2025-05/0kuEyY2kBiTnrZV1-slide-3.jpg)

---

Aqui você poderá ver todos os <span style="text-decoration: underline;">atributos</span> e <span style="text-decoration: underline;">dados</span> do documento do qual clicou, bem como o nome dos campos e valores. Aqui você pode clicar em qualquer campo e alterar seu valor **(Não se esqueça de clicar em *<span style="color: rgb(45, 194, 107);">Save</span>* após as alterações)**, e clique em **<span style="color: rgb(241, 196, 15);">Back</span>** para voltar para a sessão de coleções:

[![Slide_4.jpg](https://bookstack.ljit.com.br/uploads/images/gallery/2025-05/scaled-1680-/neOTY5BRx3m5UkeW-slide-4.jpg)](https://bookstack.ljit.com.br/uploads/images/gallery/2025-05/neOTY5BRx3m5UkeW-slide-4.jpg)