sothis-contratacao-api/src/routes/routes.js

35 lines
1.8 KiB
JavaScript

const express = require('express');
const router = express.Router();
const contratacaoController = require('../modules/contratacao/contratacao.controller.js');
// Rota para consulta de viabilidade
router.post('/viabilidade', contratacaoController.handleViabilidade);
// Rota para criação de prospecto no Hubsoft
router.post('/prospecto', contratacaoController.handleCriarProspecto);
// router.post('/teste', controller.handleTeste);
module.exports = router;
/*
DESCRIÇÃO:
Este arquivo é o roteador principal da aplicação. Ele é responsável por definir todos os endpoints (URLs) da API e associar cada um a uma função específica do controller correspondente.
FLUXO:
1. Este arquivo é carregado pelo `app.js`, que monta este roteador sob o prefixo `/api`. Isso significa que todas as rotas definidas aqui serão acessíveis a partir de `/api/...`.
2. Ele importa o `contratacao.controller.js`, que contém a lógica para manipular as requisições.
3. Define as seguintes rotas:
- `POST /viabilidade`:
- Quando uma requisição POST é feita para `/api/viabilidade`, o Express direciona a chamada para a função `handleViabilidade` no `contratacaoController`.
- Esta rota é usada para verificar a viabilidade de um serviço em um determinado endereço.
- `POST /prospecto`:
- Quando uma requisição POST é feita para `/api/prospecto`, a chamada é direcionada para a função `handleCriarProspecto` no `contratacaoController`.
- Esta rota é usada para criar um novo cliente potencial (prospecto) no sistema.
4. Finalmente, o objeto `router` configurado é exportado para ser usado pelo `app.js`.
Este arquivo centraliza a definição de todas as rotas da API, mantendo o código organizado e facilitando a visualização de todos os endpoints disponíveis.
*/