API de Consultas Médicas

Uma API serverless para o gerenciamento de consultas médicas, construída com Node.js, TypeScript e Serverless Framework.

---

✨ Visão Geral

Essa API fornece endpoints para gerenciar agendas médicas e consultas, oferecendo um serviço rápido e escalável para aplicações de saúde. Todas as rotas foram testadas no Postman para garantir o correto funcionamento e a confiabilidade das operações.

---

⚙️ Pré-requisitos

• Node.js v14 ou superior
• npm ou yarn
• Serverless Framework CLI

---

🚀 Instalação e Execução

1. Instale as dependências do projeto:

   npm install

2. Execute os testes para garantir que tudo está funcionando corretamente:

   npm test

3. Inicie o servidor de desenvolvimento local para trabalhar no projeto:

   npm run dev

📌 API Endpoints

Listar Agendas Médicas

• Método: GET
• Rota: /agendas

Retorna uma lista com as agendas de todos os médicos disponíveis.

---

Criar Agendamento

• Método: POST
• Rota: /agendamento
• Corpo da Requisição:

  {
    "medico_id": 1,
    "paciente_nome": "Carlos Almeida",
    "data_horario": "2024-10-05 09:00"
  }

Utilize este endpoint para criar um novo agendamento para o paciente especificado na data e horário desejados.

---

🗂 Estrutura do Projeto

A organização do projeto foi planejada para manter o código limpo, modular e fácil de manter. Cada domínio possui seus próprios arquivos de controle, serviços, interfaces e mocks.

/src
  ├── /agenda            # Domínio das agendas médicas
  │   ├── /controller    # Lógica de controle e gestão das agendas
  │   ├── /service       # Lógica de negócios para agendas
  │   ├── /interface     # Tipagens e interfaces relacionadas a agendas
  │   └── /mocks         # Dados fictícios para testes de agendas
  └── /agendamento       # Domínio dos agendamentos
      ├── /controller    # Lógica de controle e gestão dos agendamentos
      ├── /service       # Lógica de negócios para agendamentos
      ├── /interface     # Tipagens e interfaces relacionadas a agendamentos
      └── /mocks         # Dados fictícios para testes de agendamentos

🧪 Testes

Execute os testes unitários:

npm test

Observação: Todas as rotas foram testadas no Postman para garantir a integridade da API.

---

🔍 Linting e Formatação

Para manter o código limpo e consistente, foram configurados scripts para análise estática e formatação:

• Análise com ESLint:

  npm run lint

• Formatação com Prettier:

  npm run format
  

---

🛠 Tecnologias Utilizadas

• Node.js e TypeScript para backend e tipagem segura.
• Serverless Framework para uma infraestrutura serverless e escalável.
• Postman para teste e validação dos endpoints.

Observação: Sinta-se à vontade para explorar o projeto! Boa codificação! 🚀