Voll.med é uma clínica médica fictícia que precisa de um aplicativo para gerenciamento de consultas. O aplicativo deve ter funcionalidades para registrar médicos e pacientes, bem como agendar e cancelar consultas.
Funcionalidades
Como Usar Este Projeto
- Clone o Repositório:
git clone https://github.com/AfranioCaires/vollmed-api.git
- Configure o Banco de Dados:
- Certifique-se de ter o MySQL instalado e em execução.
- Defina as seguintes variáveis de ambiente no seu ambiente de desenvolvimento ou em um arquivo
.env
:
spring.datasource.url=jdbc:mysql://${DB_HOST}:${DB_PORT}/${DB_NAME}
spring.datasource.username=${DB_USER}
spring.datasource.password=${DB_PASSWORD}
Substitua ${DB_HOST}
, ${DB_PORT}
, ${DB_NAME}
, ${DB_USER}
e ${DB_PASSWORD}
pelos detalhes reais da sua conexão com o banco de dados.
- Construa o Projeto:
mvn clean install
- Execute o Aplicativo:
Execute o aplicativo Spring Boot usando Maven:
mvn spring-boot:run
Tecnologias
As seguintes tecnologias foram usadas no desenvolvimento da API REST para o projeto:
Documentação da API
Sumário
- Visão Geral
- Servidores
- Endpoints
Servidores
Endpoints
/pacientes
GET /pacientes
- Tags: patient-controller
- ID da Operação: patientListData
- Parâmetros:
Nome | Local | Obrigatório | Esquema |
---|
pageable | query | true | Pageable |
Respostas:
PUT /pacientes
- Tags: patient-controller
- ID da Operação: updatePatientData
- Corpo da Requisição:
Respostas:
Código | Descrição | Conteúdo |
---|
200 | OK | string |
POST /pacientes
- Tags: patient-controller
- ID da Operação: registerPatient
- Corpo da Requisição:
Respostas:
Código | Descrição | Conteúdo |
---|
200 | OK | string |
/medicos
GET /medicos
- Tags: physician-controller
- ID da Operação: physicianList
- Parâmetros:
Nome | Local | Obrigatório | Esquema |
---|
pageable | query | true | Pageable |
Respostas:
PUT /medicos
- Tags: physician-controller
- ID da Operação: updatePhysicianData
- Corpo da Requisição:
Respostas:
Código | Descrição | Conteúdo |
---|
200 | OK | string |
POST /medicos
- Tags: physician-controller
- ID da Operação: register
- Corpo da Requisição:
Respostas:
Código | Descrição | Conteúdo |
---|
200 | OK | string |
/consultas
POST /consultas
- Tags: appointment-controller
- ID da Operação: createAppointment
- Corpo da Requisição:
Respostas:
Código | Descrição | Conteúdo |
---|
200 | OK | object |
DELETE /consultas
- Tags: appointment-controller
- ID da Operação: cancel
- Corpo da Requisição:
Respostas:
Código | Descrição | Conteúdo |
---|
200 | OK | string |
/auth
POST /auth
- Tags: auth-controller
- ID da Operação: signIn
- Corpo da Requisição:
Respostas:
Código | Descrição | Conteúdo |
---|
200 | OK | string |
/pacientes/:id
GET /pacientes/:id
- Tags: patient-controller
- ID da Operação: getPatient
- Parâmetros:
Nome | Local | Obrigatório | Esquema |
---|
id | path | true | integer (int64) |
Respostas:
Código | Descrição | Conteúdo |
---|
200 | OK | string |
DELETE /pacientes/:id
- Tags: patient-controller
- ID da Operação: deletePatient
- Parâmetros:
Nome | Local | Obrigatório | Esquema |
---|
id | path | true | integer (int64) |
Respostas:
Código | Descrição | Conteúdo |
---|
200 | OK | string |
/medicos/:id
GET /medicos/:id
- Tags: physician-controller
- ID da Operação: getPhysician
- Parâmetros:
Nome | Local | Obrigatório | Esquema |
---|
id | path | true | integer (int64) |
Respostas:
Código | Descrição | Conteúdo |
---|
200 | OK | string |
DELETE /medicos/:id
- Tags: physician-controller
- ID da Operação: deletePhysician
- Parâmetros:
Nome | Local | Obrigatório | Esquema |
---|
id | path | true | integer (int64) |
Respostas:
Código | Descrição | Conteúdo |
---|
200 | OK | string |