Sofia Mobile 💜

Sofia é um Software Orientado por Inteligência Artificial para Auxílio ao Pré-diagnóstico de Crianças de 0 a 2 Anos com Manifestações Comportamentais do Transtorno do Espectro Autista (TEA). O aplicativo mobile CAD (Computer-aided diagnosis) é destinado ao auxílio de profissionais da saúde na triagem e identificação de sinais do TEA. 💜 Nosso Objetivo 💜 é promover a acessibilidade ao diagnóstico precoce de TEA! 💜

Publicação Qualis B2 - ISSN: 2446-7049

Este projeto foi publicado na Revista Tecnológica da Fatec Americana - ISSN: 2446-7049.

FETEPS 2024

Este projeto participou da 15ª Feira Tecnológica do Centro Paula Souza - FETEPS.

Descrição do projeto 💜

A Sofia API é uma API RESTful desenvolvida com Spring Boot e Java. Ela foi projetada para ser utilizada pelo Sofia Mobile para realização do CRUD com MongoDB.

Ficou interessado? Veja mais no nosso pitch de apresentação da SOFIA, ou acesse o nosso site. 💜

Pré-Requisitos 💜

• JDK (Java Development Kit)
• MongoDB
• Git
• Alguma IDE de sua preferência

Dependências 💜

Este projeto depende da seguinte API:

• Sofia api-flask (Neural Network)
  

Configuração do Projeto 💜

1. Clone o repositório para sua máquina local usando o seguinte comando

git clone https://github.com/aasjunior/com.sofia.restapi.git

2. Importe o projeto na sua IDE preferida. Por exemplo:

• No IntelliJ: Vá para File > Open, selecione o diretório do projeto e clique em OK. Certifique-se de que o Maven está configurado corretamente.

• No Eclipse: Clique em File > Import > Maven > Existing Maven Projects, selecione o diretório do projeto e clique em Finish.

• No VSCode: Instale as extensões Spring Boot Extension Pack e Extension Pack for Java. Abra o projeto sofia-api.

3. Se a sua IDE tiver um cliente REST API integrado (como o HTTP Client no IntelliJ), você pode usá-lo para testar as requisições HTTP. Caso contrário, você pode usar um cliente REST API externo, como Postman ou Insomnia.

4. Certifique-se de que o JDK está instalado e configurado corretamente na sua IDE. No IntelliJ, você pode verificar isso em File > Project Structure > Project Settings > Project > Project SDK.

5. Certifique-se de que o MongoDB está instalado e funcionando corretamente. Você pode usar o MongoDB Compass para visualizar e interagir com seus dados no MongoDB.

6. Inicie a aplicação. A API estará rodando em http://localhost:8080

7. Acesse a documentação da API no Swagger UI em: http://localhost:8080/swagger-ui.html

Instalação via Docker 💜

O projeto pode ser criado via Docker Compose. Existem dois níveis de configuração disponíveis:

• Docker Compose Local: Para rodar apenas a API Spring Boot localmente.
• Docker Compose Completo: Para provisionar toda a infraestrutura do SOFIA (API + FastAPI + NGINX).

Docker Compose Local (API Spring Boot)

Para iniciar apenas o container da API Spring Boot:

1. Acesse o diretório /sofia-api:

cd sofia-api

2. Execute o comando para iniciar o container:

docker-compose up

Docker Compose Completo (Infraestrutura SOFIA)

Para provisionar o back-end completo do SOFIA:

1. Navegue até o diretório /infra:

cd infra

2. Execute o comando para subir todos os serviços (API, FastAPI e NGINX):

docker-compose up

Sofia-Server 💜

Para provisionar um servidor Ubuntu e configurar toda a infraestrutura do SOFIA, consulte a documentação do Sofia-Server.

Esta documentação inclui:

• Passos para criar um servidor Ubuntu na AWS ou localmente.
• Instalação do Docker e Docker Compose.
• Execução do ambiente completo de back-end utilizando o arquivo docker-compose.yml, disponívem em infra/docker-compose.yml.

⚠️ Importante: Certifique-se de configurar as variáveis de ambiente corretamente para conectar ao MongoDB Atlas, ou tenha o MongoDB instalado localmente.

Endpoints 💜

A API possui os seguintes endpoints:

Type	Path	Authorization	Obs.
POST	/auth/login	null	Realiza autenticação do usúario.
POST	/auth/register	null	Registra um novo usuário.
POST	/auth/refresh	Bearear token	Atueliza o token de autenticação do usuário.
GET	/patients	Bearear token	Retorna uma lista de todos os pacientes.
POST	/patients-with-guardian	Bearear token	Insere um novo paciente e responsável.
GET	/patients/{id}	Bearer token	Retorna um paciente específico pelo ID.
DELETE	/patients/{id}	Bearer token / Admin.	Remove um paciente pelo ID.
POST	/checklist/qchat/submit	Bearer token	Submete o questionário Q-Chat 10 preenchido.
GET	/checklist/qchat/patientId	Bearer token	Retorna o resultado do teste do paciente.

Login

• URI: /auth/login
• Método: POST
• Request body: application/JSON
• Status: 200 Ok
• Entrada:

{
"email": "admin@email.com",
"password": "admin"
}

• Saída:

{
"accessToken": "string <JWT>",
"refreshToken": "string <JWT>",
"userId": "string"
}

Register

• URI: /auth/register
• Método: POST
• Request body: application/JSON
• Status: 200 Ok
• Entrada:

{
"firstName": "John",
"lastName": "Doe",
"username": "john.doe",
"email": "john.doe@email.com",
"password": "123",
"role": "USER"
}

• Saída:

{
"id": "665bbbc64d3b496d45370802",
"firstName": "John",
"lastName": "John",
"username": "john.doe",
"email": "john.doe@email.com",
"role": "USER",
"registrationDate": "2024-06-01T21:24:38.7597449"
}

Refresh Token

• URI: /auth/refresh
• Método: POST
• Request body: application/JSON
• Status: 200 Ok
• Entrada:

{
"token": "string <JWT>"
}

• Saída:

{
"accessToken": "string <JWT>",
"refreshToken": "string <JWT>",
"userId": "string"
}

Patient with Guardian

• URI: /patients/patient-with-guardian
• Método: POST
• Request body: application/JSON
• Headers: Authorization: Bearer token
• Status: 201 Created
• Entrada:

{
"patientRequest": {
"firstName": "string",
"lastName": "string",
"birthDate": "string",
"gender": "Male",
"ethnicity": "White",
"familyCases": true,
"pregnancyComplication": true,
"premature": true
},
"guardianRequest": {
"firstName": "string",
"lastName": "string",
"phone": "string",
"email": "string"
},
"kinship": "Mother"
}

• Saída:

{
"id": "string",
"firstName": "string",
"lastName": "string",
"birthDate": "string",
"gender": "Male",
"ethnicity": "White",
"familyCases": true,
"pregnancyComplications": true,
"premature": true,
"guardians": {
"guardian1": {
"id": "string",
"firstName": "string",
"lastName": "string",
"phone": "string",
"email": "string",
"patients": {
"relationship1": {
"patientId": "string",
"guardianId": "string",
"kinship": "Mother"
},
"relationship2": {
"patientId": "string",
"guardianId": "string",
"kinship": "Mother"
}
}
},
"guardian2": {
"id": "string",
"firstName": "string",
"lastName": "string",
"phone": "string",
"email": "string",
"patients": {
"relationship1": {
"patientId": "string",
"guardianId": "string",
"kinship": "Mother"
}
}
}
},
"registerDate": "2024-06-02T00:34:27.997Z",
"ageMonths": 0
}

Q-Chat 10

• URI: /checklist/qchat/submit
• Método: POST
• Request body: application/JSON
• Headers: Authorization: Bearer token
• Status: 200 Ok
• Entrada:

{
"patientId": "string",
"questions": {
"A1": true,
"A2": true,
"A3": true,
"A4": true,
"A5": true,
"A6": true,
"A7": true,
"A8": true,
"A9": true,
"A10": true,
}
}

• Saída:

{}

• URI: /checklist/qchat/{patientId}
• Método: GET
• Headers: Authorization: Bearer token
• Status: 200 Ok
• Entrada:

patientId: String

• Saída:

{
"testId": "string",
"testName": "QChat",
"testType": "SCREENING",
"registerDateTime": "2024-06-02T00:48:57.304Z",
"result": true
}

Deploy 💜

Está aplicação possui uma versão disponível pelo endereço abaixo. Porém para utilização da aplicação móvel ainda se faz necessário a utilização localmente em conjunto com a api-flask (Rede Neural).

https://sofia-api-hsrn.onrender.com/swagger-ui/index.html

Tecnologias 💜

Nosso Time AJA 💜

You can see more about us in our profile:

• Amanda
• Junior
• Aline

Aviso

Esta é uma iniciativa acadêmica, sendo assim, não possui todas as funcionalidades e características de uma aplicação real.