Grupo 11:
- Pedro Ono - RM 354950
- Elton Xavier Souza - RM 354254
- Welder Ressutti - RM 354557
Desenvolvido por: Welder Ressutti
O microsserviço de gerenciamento de pacientes no Glicare é responsável por executar operações CRUD, garantindo a administração eficiente dos dados dos pacientes.
Para completar os cadastros, o microsserviço integra-se à API ViaCEP por meio de comunicação síncrona utilizando OpenFeign, permitindo a obtenção automática do endereço completo do paciente.
A persistência dos dados é realizada em um banco PostgreSQL, com gerenciamento de migração de schemas via Flyway.
Para garantir respostas padronizadas e um tratamento adequado de erros, foram implementadas exceções personalizadas, gerenciadas globalmente pelo Rest Controller Advice e Exception Handler, que retornam informações detalhadas, incluindo timestamp, status code, error, message e path.
Endpoint: /api/patient
É realizado validação completa e limpeza dos dados de entrada utilizando padrões RegEx, impedindo inconsistência de dados. Todos os dados da requisição são obrigatórios e os campos de celular, CPF e CEP, podem ser enviados formatados ou não.
Exemplo de formatações aceitas:
Celular: 11-111111111 ou 11111111111 | CPF: 111.111.111-11 ou 11111111111 | CEP: 11111-111 ou 11111111
Já na camada core da aplicação, dentro da classe de domínio CPF, é utilizado um algoritmo que verifica se o CPF é válido/verdadeiro.
O usuário deve informa apenas o CEP e número do seu endereço, as demais informações do endereço serão preenchidas automaticamente através da integração com a API ViaCEP.
O sistema impede o cadastro de paciente com CPF e/ou e-mail iguais.
Endpoint: /api/patient/{patientId}
Todo o padrão de validação, limpeza e consistência de dados do processo de cadastro se matém aqui também, porém, aqui, todos os campos são opcionais, pode ser enviado apenas um, alguns ou todos os campos para a atualização do paciente.
Endpoint: /api/patient/{patientId} /api/patient?email= /api/patient
Pode ser obtido o paciente pelo seu id ou e-mail. Também é possível obter todos os pacientes de uma vez.
Endpoint: /api/patient/{patientId}
Para deletar um paciente basta passar seu id no endpoint.
Para mais informações sobre a API, como, request, response e status code, consultar a documentação Swagger.
- Java 17 – Linguagem de programação utilizada no desenvolvimento do sistema.
- Spring Web – Base para a construção das APIs RESTful do sistema.
- Spring Data JPA – Gerenciamento da persistência de dados e integração com o banco de dados.
- PostgreSQL – Banco de dados relacional utilizado para armazenar as informações do sistema.
- Spring Cloud – Conjunto de ferramentas para facilitar a arquitetura baseada em microsserviços.
- OpenFeign – Cliente HTTP declarativo para facilitar a comunicação síncrona entre os microsserviços.
- Flyway – Controle de versionamento do banco de dados, garantindo migrações seguras.
- Spring Validation – Validação de dados recebidos nas requisições das APIs.
- Swagger – Documentação interativa das APIs para facilitar testes e integração.
- Lombok – Redução de boilerplate no código, simplificando a criação de classes Java.
- API ViaCEP – Serviço utilizado para buscar informações de endereços a partir do CEP, garantindo maior precisão e automação no cadastro de pacientes.
- Docker – Containerização dos microsserviços para facilitar o deploy e a escalabilidade.
A arquitetura hexagonal consiste na ideia de utilizar portas e adaptadores para realizar a integração entre a camada externa e interna, isolando o core da aplicação para que alterações externas não interfiram nas regras de negócio e casos de uso.
Este microsserviço foi desenvolvido seguindo os padrões de API RESTful, arquitetura hexagonal, e também respeitando os princípios SOLID de isolamento de responsabilidades.
A arquitetura desta aplicação foi desenvolvida da seguinte forma:
- Git (caso queira clonar o repositório, mas você pode apenas baixá-lo):
- Docker Desktop (para executar a aplicação através de containers):
Para clonar o repositório, use o comando:
git clone https://github.com/welderessutti/api-patientCaso não queira clonar o repositório, você pode baixá-lo em GitHub.
No terminal, dentro do diretório raíz do projeto (local onde se encontra o arquivo pom.xml da aplicação), execute o comando abaixo para subir o container da aplicação e do banco de dados PostgreSQL:
docker compose up -dO Docker tentará baixar a imagem no repositório do Docker Hub, caso ele não encontre a imagem, ele realizará a build da aplicação (.jar), criará a imagem e executará os containers automaticamente.
Antes do container da aplicação subir, ele aguardará o container do banco de dados PostgreSQL estar pronto utilizando um healthcheck, quando pronto, o container da aplicação inicia, realiza a migração do banco de dados e suas tabelas automaticamente utilizando o Flyway, e estará disponível para acesso em:
http://localhost:8080/api/patient
A documentação da API pode ser acessada via Swagger UI. Após executar a aplicação, acesse:
http://localhost:8080/api/swagger-ui/index.html
Lá você encontrará detalhes sobre todos os endpoints disponíveis, parâmetros de requisição e resposta.
As coleções de requisições do Postman e Insomnia estão disponíveis no diretório api-requests/
Se você deseja testar os endpoints da API, basta importar os arquivos de coleção no Postman ou Insomnia e executar as requisições conforme necessário.