Games API

📌 Visão Geral

O projeto se trata de uma API Rest desenvolvida com Java e Spring Boot, contendo as funcionalidades de CRUD de desenvolvedores, consoles e jogos.

BaseURL: https://games-api-3nbk.onrender.com

🚀 Tecnologias utilizadas

• Java;
• Spring Boot;
• Lombok;
• Jpa Persistance;
• Starter Validation;
• PostgreSQL;
• Flyway;
• Swagger.

📚 Documentação

Todos os endpoints da API foram documentados usando Swagger. Para visualizar basta acessar a URL abaixo.

Link: https://games-api-3nbk.onrender.com/swagger-ui/index.html

💻 Instalação, Dependências e Executando o Projeto

Para poder executar a aplicação é necessário ter o java, o maven e o docker instalados.

1. Clone este repositório

git clone git@github.com:<seu-usuario-github>/games-api.git

2. Vá até o diretório raiz do projeto

cd games-api

3. Instalando as dependências da aplicação

mvn clean install

4. Crie os contâiners

docker-compose up -d

5. Execute a aplicação

mvn spring-boot:run
# O servidor será executado na porta 8080 (http://localhost:8080)

💻 Testando as requisições

Você pode testar as requisições a partir do Json do Insomnia disponibilizado no seguinte arquivo clicando aqui.