https://github.com/purpuraambiental/api-mg
API para a conexão com o banco de dados MongoDB utilizando Redis para cachê e docker compose para orquestração em ambiente dev
https://github.com/purpuraambiental/api-mg
docker java maven mongodb mongodb-atlas redis rest-api spring-boot spring-mvc websocket
Last synced: 9 months ago
JSON representation
API para a conexão com o banco de dados MongoDB utilizando Redis para cachê e docker compose para orquestração em ambiente dev
- Host: GitHub
- URL: https://github.com/purpuraambiental/api-mg
- Owner: PurPuraAmbiental
- Created: 2025-08-20T12:07:13.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-10-02T14:04:08.000Z (10 months ago)
- Last Synced: 2025-10-02T14:30:11.326Z (10 months ago)
- Topics: docker, java, maven, mongodb, mongodb-atlas, redis, rest-api, spring-boot, spring-mvc, websocket
- Language: Java
- Homepage: https://mongodb-api-purpura.onrender.com
- Size: 205 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# **API para Acesso ao MongoDB do Purpura 💜**
## **Overview 📝**
Bem-vindo à API do MongoDB do Purpura! Esta API foi projetada para gerenciar e organizar os dados essenciais do Purpura, abrangendo os seguintes domínios:
- **Empresas**: Gerencie informações de empresas cadastradas.
- **Chaves Pix**: Controle e organize chaves Pix associadas.
- **Endereços**: Administre endereços de forma eficiente.
- **Resíduos**: Gerencie dados relacionados a resíduos.
- **Conversas**:
- Inclui suporte a **chat em tempo real** utilizando WebSockets com Redis.
- Permite comunicação instantânea entre usuários utilizando conteúdo em markdown.
-----
## **Funcionalidades Principais 🚀**
### **Empresas**
- Adicionar, atualizar, buscar e deletar empresas.
- Pesquisar empresas com filtros avançados.
### **Chaves Pix**
- Adicionar, atualizar, buscar e deletar chaves Pix.
- Gerenciamento de chaves Pix com validações específicas.
### **Endereços**
- Adicionar, atualizar, buscar e deletar endereços.
- Listagem completa de endereços cadastrados.
### **Resíduos**
- Adicionar, atualizar, buscar e deletar resíduos.
- Controle detalhado de resíduos gerados.
### **Conversas e Chat em Tempo Real**
- Suporte a WebSockets para comunicação em tempo real.
- Gerenciamento de mensagens e chats.
-----
## **Testes e Ferramentas 🧪**
### **Coleção de Testes do Bruno**
- Utilize a coleção de testes localizada em: `bruno-api-mg` para validar as funcionalidades da API.
### **Swagger**
- Explore e teste os endpoints da API diretamente no Swagger:
[https://mongodb-api-purpura.onrender.com/swagger-ui/index.html#](https://mongodb-api-purpura.onrender.com/swagger-ui/index.html#)
### **WebSockets**
- Teste a funcionalidade de WebSockets utilizando o projeto Python disponível em:
[websocket-test-api-mg](websocket-test-api-mg/README.md)
-----
## **Como Executar a API 🛠️**
1. Certifique-se de ter o Docker e o IntelliJ instalado.
2. Clone este repositório.
3. Utilize o plugin DotEnv para ter acesso às variáveis de ambiente.
4. Configure as variáveis de ambiente conforme o arquivo `.env`
5. Mude as configurações de execução do projeto `ApiMgApplication` para utilizar o perfil `dev`.
6. Dentro ainda das configurações, ative o plugin Dotenv.
7. Utilize o arquivo `compose.yaml` para configurar e iniciar os serviços necessários.
8. Execute o projeto.
9. Acesse o Swagger para explorar os endpoints disponíveis.
-----
## **Contribuidores 💃**
Criado com 💜 por:
- **Felipe Fernandes dos Santos Oliveira**: Back-end, testes e documentação.
- **Emílio Stuart Palumbo**: Esteira de deploy e infraestrutura.