README.md

API Games 🎮

Esta é uma API bem simples desenvolvida com fins de estudo, não apenas do SpringBoot como também a metodologia Rest. Para emular o real uso, fora usado "Games" como objeto a ser adquirido pela API, onde é possível realizar as operações de um CRUD se baseando em um objeto com "nome e categoria"(name, category).

Tecnologias

As seguintes ferramentas foram usadas na construção do projeto:

• Spring

Plugins:

• Spring Data JPA
• Validation
• Spring Web
• Spring Boot DevTools
• H2 Database
• SpringFox - Swagger

Pré-Requisitos

Antes de começar vale lembrar, é necessário possuir o Java instalado e o Maven baixado em sua máquina e como estamos trabalhando com uma API precisamos de alguma forma fazer as requisições, então deixo o Postman como recomendação. É bacana também você possuir um editor para trabalhar com o código, fica a dica o VSCode.

Funcionalidades

• Find All - Get("/api/games");
• Create - Post("/api/games");
• Find by Id - Get("/api/games/{id}");
• Find by Name - Get("/api/games/name/{param}");
• Find by Category - Get("/api/games/category/{param}");
• Update - Put("/api/games/{id}");
• Delete - Delete("/api/games/{id}");
• Docs - Get("/swagger-ui/");

Rodando a aplicação

# 1. Clone este repositório
$ git clone https://github.com/IN0C3NC10/API-Games.git

# 2. Abra o projeto no seu editor de preferência

# 3. Crie o arquivo "application.properties" em "./src/main/resources/"

# 4. Nele contém algumas configurações como porta, configurações do banco e etc, segue os dados presentes no meu:
      # ..porta da aplicação
      server.port=8088
      # ..habilita o console do H2 e a rota é o path
      spring.h2.console.enabled=true
      spring.h2.console.path=/h2-console
      # ..as informações do banco de dados H2
      spring.datasource.url=jdbc:h2:mem:testdb
      spring.datasource.username=sa
      spring.datasource.password=
      spring.datasource.driver-class-name=org.h2.Driver
      # ..exibe no console o sql de criação da tabela
      spring.jpa.show-sql=true
      spring.jpa.properties.hibernate.format_sql=true
      spring.jpa.defer-datasource-initialization=true

# 5. Selecione o arquivo principal e o execute.

# Obs. Utilize o Postman para realizar as "tarefas".
#      A rota para acessar o console do H2 é "/h2-console".
#      Vale citar que sempre que iniciar o projeto, todo o conteúdo anterior é deletado e os 2 objetos na "main" são inseridos.

#BeHappy!

Autor

Feito com ❤️ por Bruno Inocencio!