########################################################################

poll-rest-api

Poll rest api java 1.8 repository

Esta API serve para criação de votações. Este projeto é um dos teste para o cargo de desenvolvedor Sr.

Você pode obter mais informações sobre o projeto poll-rest-api , seus componentes e motivação aqui.

Tecnologias

Java 1.8
Spring Boot 2.3.2.RELEASE
MySQL (Neste projeto utilizamos o serviço AWS de banco de dados chamado RDS)

Você pode obter mais informações sobre o RDS da AWS, aqui

JPA
Lombok

Requisitos dev

Eclipse ou Intellij IDEA
JDK 1.8

Key dependencies

Abaixo uma lista das principais dependências deste projeto.

Plugin	README
SpringBoot	[aqui][PlDb]
Lombok	[aqui][PlGh]
Mysql	[aqui][PlGd]

Criando uma nova Branch

Na pasta raiz, sempre que for criar uma nova feature

git checkout -b feature/featureName develop

-- Close Branchs after merge with develop

Variáveis de ambiente necessárias

AWS_MYSQL_URL (Acesso ao RDS na Amazon)
AWS_MYSQL_USER (Usuário para acesso ao RDS)
AWS_MYSQL_PASS (Senha de acesso ao RDS)

Configuração MYSQL 8+ para amiente de desenvolvimento

Exemplo de criação de um usuário: newuser
Exemplo de criação de uma senha: user_password
Usuário e senha devem ser adicionados no arquivo application.properties (se você utilizar o profile=default) application-local.properties (se você utilizar o profile=local)

Criando schema e um usuário

mysql -u root -p
CREATE USER 'newuser'@'localhost' IDENTIFIED BY 'user_password';
CREATE USER 'newuser'@'%' IDENTIFIED BY 'user_password';
CREATE DATABASE poll;
GRANT ALL PRIVILEGES ON *.* to 'newuser'@'%';
ALTER USER 'newuser'@'%' IDENTIFIED WITH mysql_native_password BY 'user_password';
FLUSH PRIVILEGES;

Modelo de Dados

Este projeto utilizará inicialmente a base de dados Dynamo DB, considerando o seguinte modelo de dados:

poll

ID	DESCRIPTION
1	`"Enquete 1"`
2	`"Enquete 2"`
3	`"Enquete 3"`
4	`"Enquete 4"`

Como usar (ambiente de desenvolvimento)

Como gerar os testes e o html de cobertura

Na pasta raiz, executar:

./mvnw verify

Abrir o arquivo target/site/jacoco/index.html

Executando o maven

Na pasta raiz, executar com profile LOCAL:
Certifique-se de incluir as configurações necessárias no arquivo application-local.properties.

mvn spring-boot:run -Dspring-boot.run.profiles=local -Dspring-boot.run.jvmArguments="-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=n,address=5005"

Ou simplesmente:

mvn spring-boot:run

Utilizando o Docker (desenv)

Na pasta raiz, executar:

docker-compose up --build

Ou ainda:

docker build -t alexjavabraz/poll-api:0.0.1 .

Então para rodar a aplicação.

docker run -d -p 8080:8080 --restart="always" --env AWS_MYSQL_URL={YOUR_DATABASE_URL} --env AWS_MYSQL_USER={DATABASE_USERNAME} --env AWS_MYSQL_PASS={DATABASE_PASSWORD} alexjavabraz/poll-api:0.0.1

Exemplo:

docker run -d -p 8080:8080 --restart="always" --env AWS_MYSQL_URL="jdbc:mysql://172.17.0.4:3306/poll?useSSL=false&autoReconnect=true" --env AWS_MYSQL_USER=newuser --env AWS_MYSQL_PASS=user_password alexjavabraz/poll-api:0.0.1

Utilizando o Docker (prod)

Utilize o seguinte comando para executar via docker diretamente da versão mais atualizada do hub.docker.com:

docker pull alexjavabraz/poll-api:0.0.1
docker images alexjavabraz/poll-api

Verifique o IMAGE_ID, e em seguida:

docker run --env AWS_MYSQL_URL="{YOUR_DATABASE_URL}" --env AWS_MYSQL_USER={DATABASE_USERNAME} --env AWS_MYSQL_PASS={DATABASE_PASSWORD} {IMAGE_ID}

Exemplo:

docker run --env AWS_MYSQL_URL="jdbc:mysql://172.17.0.3:3306/poll?useSSL=false&autoReconnect=true" --env AWS_MYSQL_USER=newuser --env AWS_MYSQL_PASS=user_password b18fbc199c94

Endpoints ativos

[GET] /poll/:id
[POST] /poll
[POST] /poll/:id/vote
[GET] /poll/:id/stats
[GET] /actuator/health
[GET] /swagger-ui.html
[GET] /v2/api-docs

alexjavabraz / poll-rest-api