Wallet API

Projeto criado para servir de referência ao curso API RESTfull com Spring Boot utilizando TDD, CI e CD que está divulgado na plataforma Udemy, a principal funcionalidade dessa API é permitir o cadastro de usuários para manipular de maneira individual uma carteira, inserindo, alterando, removendo ou adicionado itens.

Detalhes do projeto

Esse projeto possui as seguintes características:

Projeto criado com Spring Boot e Java 8
Banco de dados Postgres com JPA e Spring Data JPA
Versionamento de banco de dados com Flyway
Testes com JUnit e Mockito com banco H2 em memória
Caching com EhCache
Nuvem do Heroku
Integração contínua com TravisCI
Project Lombok
Documentação dos endpoints com Swagger
Segurança da API com autenticação via tokens JWT

Como executar a aplicação

Certifique-se de ter o Maven instalado e adicionado ao PATH de seu sistema operacional, assim como o Git, crie um banco de dados no postgres e altere o arquivo application.properties informando as credenciais para a aplicação acessar a base de dados, não se preocupe com a criação das tabelas, o flyway se encarregará dessa função.

git clone https://github.com/vitoralves/walletAPI
cd walletAPI
mvn spring-boot:run
Acesse os endpoints através da url http://localhost:8080

Também é possível compilar o projeto para executar em um ambiente de produção, para isso execute o seguinte comando na raiz do projeto

mvn clean install

O pacote será gerado dentro da pasta target, basta executá-lo com o comando abaixo, não esquecendo de configurar qual o profile e a porta que a aplicação deverá utilizar. Também é necessário criar uma variável de ambiente com as credenciais de acesso ao banco de dados com o nome $DATABASE_URL ou alterar o arquivo application-prod.properties.

java -jar -Dspring.profiles.active=prod -Dserver.port=443 walletAPI-0.0.1-SNAPSHOT.jar

Como autenticar na API

Antes de fazer requisições nos endpoint você deve estar autenticado, antes crie um usuário através de uma requisição POST na rota /user como no exemplo abaixo:

{
	"name": "Heroku User",
	"email": "user@heroku.com",
	"password": "123456"
}

Agora você pode autenticar na API e obter um token de acesso através do endpoint /auth, utilizando o email e a senha cadastrados:

{
	"email": "user@heroku.com",
	"password":"123456"
}

Você receberá um token do tipo Bearer que deve ser enviado no cabeçalho das requisições.

Como executar os testes

Os testes podem ser executados com o seguinte comando:

mvn test

Documentação

Utilize a interface do Swagger para ter acesso a documentação dos endpoints, ela está disponível na url http://localhost:8080/swagger-ui.html

Heroku

A aplicação está disponível no heroku através da url https://apiwallet.herokuapp.com/

thiagomess / walletAPI