matheuscarv69 / app-servidor-server

Esta é a uma API Restful de envios e busca de formulários.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

💻 App Servidor 📝

Esta é a uma API Restful de envios e busca de formulários.

GitHub stars badges Maven Central with version prefix filter GitHub

🤔 O que é o App Servidor ?

Visando auxiliar os cursos de Educação física, Enfermagem e Biomedicina que diariamente realizam o atendimento de muitas pessoas, dessa maneira preenchendo inúmeros documentos e formulários referentes aos seus pacientes, foi feito o desenvolvimento de uma API que é responsável pelo recebimento e envio de formulários dos cursos citados, para facilitar o processo de entrevista dos pacientes, assim tornando menos burocrático o procedimento de consultas.

🔧 Pré-Requisitos

Antes de começar você precisa ter instalado em sua máquina as seguintes ferramentas:

🎲 Executando o servidor - JAR

# Clone este repositório
$ git clone <https://github.com/matheuscarv69/app-servidor-server>

# Acesse a pasta do projeto no terminal/cmd
$ cd app-servidor-server

# Faça o build da aplicação
$ mvn clean package -P dev

# Acesse a pasta target
# cd target

# Execute a aplicação em modo de desenvolvimento
$ java -jar api-app-servidor-1.0-SNAPSHOT.jar

# O servidor iniciará na porta 8080
# Acesse - http://localhost:8080/swagger-ui.html

⚙ Fazendo o Deploy do servidor - WAR

# Dentro da raiz do projeto

# Faça o build da aplicação
$ mvn clean package -P build

📖 Documentação

O projeto foi documentado utilizando a ferramenta Swagger, para acessa-la entre no endereço:

Caso esteja executando o servidor localmente, acesse:

http://localhost:8080/swagger-ui.html

Caso esteja executando o servidor em uma VPS, acesse:

http://ip-da-vps:8080/swagger-ui.html

Swagger-home Temos dois métodos no controller do Formulário Social: Salvar e Buscar formulários.

💾 Salvar

Esse método recebe um arquivo .JSON com os dados do formulário preenchido e salva na base de dados.

Você pode testar a API usando o Insomnia clicando no botão abaixo

Run in Insomnia}

Ou caso queira pode usar o próprio Swagger clicando em Try it Out e preenchendo os dados de forma correta de acordo com o arquivo abaixo.

Neste arquivo é possível visualizar todos os ID's referentes às propriedades para realizar a inserção de forma correta.

Swagger-saveform

Insomnia

save-insomnia

🔎 Buscar

Consiste basicamente em fazer mandar um requisição do tipo GET para o mesmo end-point: /api/formsocial.

get-Insomnia

🛠 Tecnologias

As seguintes tecnologias foram utilizadas no desenvolvimento do projeto:

📱 Versão mobile

🚧 Em construção... 🚧

Repositório: app-servidor-mobile

👥 Contribuidores



Douglas Gomes

👨‍🚀

👨🏻‍💻 Autor



Matheus Carvalho
🚀

Feito por Matheus Carvalho, entre em contato!✌🏻

Linkedin Badge Gmail Badge

📝 Licença

Este projeto esta sob a licença MIT.

About

Esta é a uma API Restful de envios e busca de formulários.

License:MIT License


Languages

Language:Java 100.0%