TrabalhoWebServices

Projeto de fins acadêmicos sobre o WebServices, onde simulamos o controle de alunos de uma universidade.

Para rodar o software localmente:
1 - É pré-requisito ter o Java 8 instalado para executar essa API
2 - Faça o download do arquivo JAR que se encontra na pasta Target
3 - Acesse a pasta onde está o arquivo via Prompt de comando do seu SO
4 - Execute a seguinte linha: java -jar trabalho-0.0.1-SNAPSHOT.jar
5 - Para executar os endpoints da API, você pode usar um Postman, favor ver na documentação Swagger os endpoints possíveis
6 - Endereço do Swagger após subir o projeto http://localhost:8080/swagger-ui.html#/
7 - Todos os possíveis clientes são carregados de uma base pré-determinada.
8 - Você pode adiocinar novos clientes, onde este já estará habilitado
9 - Para conseguir consumir os dados da API, ´necessario que seja gerado um token do usuário existente, para teste há o usuario administrados padrão, dados para logon:
10 - Est API interage com um serviço externo de validação de CEP, endpoint:
https://viacep.com.br/

admin@fiap.com.br:admin

Esse projeto foi desenvolvido na IDE Eclipse, versão 2019-12 (4.14.0) e é uma Maven Project, recomendo o uso dessa ferramenta para a análise do código fonte!

EndPoints Produtivos.
Esse projeto está deployado no Heroku Cloud na seguinte URL https://escola-contas.herokuapp.com/

Documentação Swagger da API
https://escola-contas.herokuapp.com/swagger-ui.html#/

Foi criado um frontend em Android/Kotlin, para utilizar entre em:
https://github.com/fabioBaraDev/TrabalhoWebServicesFrontEnd

Exemplo do fluxo de telas que interagem com a API
https://github.com/fabioBaraDev/TrabalhoWebServicesFrontEnd/blob/master/fluxo_de_telas.gif

ENGLISH VERSION

Project for academic purposes on WebServices, where we simulate students payments from a university.

To run the software locally: 1 - It is a prerequisite to have Java 8 installed to run this API
2 - Download the JAR file that is in the Target folder
3 - Access the folder where the file is by your OS Prompt Command
4 - Run the following line: java -jar trabalho-0.0.1-SNAPSHOT.jar
5 - To run the API endpoints, you can use a Postman, please see the Swagger documentation for possible endpoints
6 - Swagger's address after uploading the project is http://localhost:8080/swagger-ui.html#/
7 - All the possible customers are loaded from a predetermined base
8 - You can add new customers, this new will be automaticaly avaliable
9 - To be able to consume the API data, it is necessary to generate an existing user token, for testing there is the standard managed user, login data:
10 - This API interacts with an external service to validate the brazilian postal number (CEP), endpoint:

https://viacep.com.br/

admin@fiap.com.br:admin

This project was developed in IDE Eclipse, version 2019-12 (4.14.0) and is a Maven Project, I recommend using this tool for analyzing the source code!

Productive EndPoints.
This project is deployed on Heroku Cloud, service link below https://escola-contas.herokuapp.com/

API Swagger documentation
https://escola-contas.herokuapp.com/swagger-ui.html#/

An frontend interface has been created on Android/Kotlin, to use it, you can get it on:
https://github.com/fabioBaraDev/TrabalhoWebServicesFrontEnd

Screen Flux Sample that interact with the api
https://github.com/fabioBaraDev/TrabalhoWebServicesFrontEnd/blob/master/fluxo_de_telas.gif

by Fabio Bara