🍃 Spring Boot Essentials

Repository that contains practical knowledge about various Spring Framework projects.

🌱 Spring projects

• Spring Framework
• Spring Boot 3
• Spring Data JPA
• Spring Security

⚙️ Project technologies

• ☕ Java 17
• 🌱 Spring
• 🌶️ Lombok
• 🐋 Docker and jib
• 🛢️ MySQL (MariaDB) and H2 Database
• 🧪 JUnit and Mockito
• 🔄 MapStruct
• 📄 SpringDoc OpenAPI (Swagger)
• 📄 Actuator, Prometheus and Grafana

🚀 Installing and Running

Follow these steps to set up the project locally on your machine.

Prerequisites

Make sure you have the following installed on your machine:

• Java 17
• Maven
• Docker Desktop
• A test API software, such as Postman
• Git

Cloning the repository

git clone https://github.com/lucasoliveirabr/springboot-essentials.git
cd springboot-essentials

Starting the database

docker-compose up

Running the Project

mvn spring-boot:run

• Open http://localhost:8080/animes in your browser.

Running Unit Testing and Integration Testing

mvn test -P all-tests

Extra: Push image to Docker Hub with jib

docker login

mvn compile jib:build

🌐 Endpoints

• Main HTTP request methods

  • GET: Paginated anime search.
    • http://localhost:8080/animes/
    • http://localhost:8080/animes?size=10&sort=id,desc
  • GET: Search all animes.
    • http://localhost:8080/animes/all
  • GET: Search for an anime by ID.
    • http://localhost:8080/animes/{id}
  • POST: Insert a new anime.
    • http://localhost:8080/animes
  • PUT: Update an existing anime.
    • http://localhost:8080/animes
  • DELETE: Delete an anime.
    • http://localhost:8080/animes/{id}

• Other routes

  • SpringDoc OpenAPI (Swagger)
    • http://localhost:8080/swagger-ui/index.html
  • Actuator
    • http://localhost:8080/actuator
  • Prometheus
    • http://localhost:9090
  • Grafana
    • http://localhost:3000