felixneto / provauol

Cliente Rest API

• Como usar
• Quais ferramentas foram usadas
• Infraestrutura adicional
• Como executar, testar, empacotar e entregar o projeto
• Instruções para ambiente de produção

Como usar

O quê você deseja fazer	Comando curl	Resposta
Verificar se o serviço está ativo	curl -X GET "http://localhost:8080/manage/health"	Mensagem json em caso de sucesso, caso demore mais de 5 segundos o retorno o serviço está fora do ar
Criar um cliente (o id é gerado na saída do comando)	curl -X POST -H "Content-Type: application/json" -d '{"name":"Pablo Silva", "age" : 39 }' "http://localhost:8080/customer"	cliente em formato json com id gerado automaticamente
Atualizar um cliente (é necessário informar o id)	curl -X PUT -H "Content-Type: application/json" -d '{"id" : 30, "name":"Almerita Silva", "age" : 79 }' "http://localhost:8080/customer"	cliente em formato json atualizado
Consultar um cliente (é necessário informar o id gerado pelo POST)	curl -X GET -H "Content-Type: application/json" "http://localhost:8080/customer/5b2ff494c5518e628ca0d381"	cliente em formato json
Apagar um cliente (é necessário informar o id)	curl -X DELETE -H "Content-Type: application/json" "http://localhost:8080/customer/30"	mensagem "Customer removed" de confirmacao de cliente excluido da base
Listar todos os clientes da base	curl -X GET -H "Content-Type: application/json" "http://localhost:8080/customer/list"	array de todos os clientes em formato json

Quais ferramentas foram usadas

Ferramenta	Link para download
Java Development Kit 8 64 bits para Windows 7	(http://www.oracle.com/technetwork/pt/java/javase/downloads/jdk8-downloads-2133151.html)
Maven 3.5.3	(https://maven.apache.org/download.cgi)
Eclipse IDE jee 2018	(https://www.eclipse.org/downloads/)
Lombok v1.18.6 "Envious Ferret"	(https://projectlombok.org/)
Spring Boot 2.1.3.RELEASE	(https://start.spring.io/)
Curl 64 bits para Windows 10	(https://curl.haxx.se/download.html#Win64)
MongoDB Community para Windows 10	(https://www.mongodb.com/download-center?#atlas)

Infraestrutura adicional

Porta do serviço

• A porta padrão para rodar este serviço é 8080. (http://localhost:8080/cliente)
• Para alterar basta informar a porta desejada no arquivo de propriedade src/main/resources/application.properties, conforme abaixo:

	server.port=8080

MongoDB

• É necessário baixar e instalar o MongoDB em qualquer máquina.
• O IP e a porta da máquina em que será instalado o MongoDB deverá ser incluido no arquivo de propriedade src/main/resources/application.properties, conforme abaixo:

	spring.data.mongodb.host=127.0.0.1
	spring.data.mongodb.port=27017

Como executar, testar, empacotar e entregar o projeto

1. Baixar e instalar o Java 1.8 ou superior
2. Baixar e instalar o Maven 3.3.9 ou superior
3. Iniciar o MongoDB 3.4 ou superior
4. Baixar os fontes

git clone https://github.com/felixneto/ProvaUOL.git
cd ProvaUOL

6. Verificar arquivo src/main/resources/application.properties

   Confirmar a porta do Serviço (porta padrão é 8080)

   Confirmar IP e Porta do MongoDB (IP padrão 127.0.0.1 e porta 27017)

7. Gerar o pacote Java em formato Jar

mvn clean install

> Dentro da pasta target, verificar a existência do arquivo com nome: ProvaFelix-0.0.1-SNAPSHOT.jar

8. Para executar

   Entrar na pasta target criada no passo anterior e executar o comando abaixo

	java -jar ProvaFelix-0.0.1-SNAPSHOT.jar

Instruções para ambiente de produção

• JDK 8 ou superior deve estar instalado na máquina que a aplicacao platcorp irá rodar
• MongoDB deve estar rodando
• Liberar portas no firewall, conforme Infraestrutura adicional
• Copiar o arquivo gerado na seção Como executar, testar, empacotar e entregar o projeto
• Executar o comando:

java -jar ProvaFelix-0.0.1-SNAPSHOT.jar

• Para verificar se o serviço está rodando execute:

curl -X GET "http://localhost:8080/manage/health"

• Retornou '{"status":"UP"}' no passo anterior? Tudo Ok e funcionando, pode utilizar todas as urls descritas em na seção Como usar.

Instruções para monitoramento

• Executar o comando abaixo para verificar se o serviço está no ar e deve retornar '{"status":"UP"}':

curl -X GET "http://localhost:8080/manage/health"

• Logs de INFO são gerados no stdout padrão (console)
• Logs de ERROR são gerados no stderr padrão (console)