Webhooks / Web API
Serviço responsável pelo recebimento de webhooks e integrações externas.
Informações Gerais
| Item | Detalhe |
|---|---|
| Versão | 1.0.0 |
| Runtime | Node.js |
| Framework | Express 4 |
| Banco | MongoDB via Mongoose 6 |
| Docs | Swagger UI em /doc |
| Porta | 9000 |
Arquitetura
utrbus_webhooks/
├── index.js # Entrypoint: Express + middlewares
├── swagger.js # Script de geração do swagger_output.json
├── swagger_output.json # Especificação OpenAPI gerada
└── app/
├── controllers/
│ ├── boardingController.js # Recebe e processa eventos de embarque
│ ├── uploadController.js # Upload de arquivos de integração
│ └── index.js # Registro dos controllers
└── models/ # Modelos Mongoose espelhados da API
├── boarding.js
├── cliente.js
├── colaborador.js
├── fretamento.js
├── motorista.js
├── rota.js
└── veiculo.jsResponsabilidades
- Recebimento de eventos externos (rastreadores, dispositivos RFID) via HTTP
- Processamento e persistência de embarques
- Upload de arquivos de integração (XML)
- Exposição de documentação OpenAPI
Setup
bash
cd utrbus_webhooks
npm install
# Desenvolvimento (com nodemon)
npm run dev
# Regenerar documentação Swagger
npm run swagger-autogen
# Produção
npm startApós iniciar, a documentação Swagger estará disponível em:
http://localhost:9000/doc