wanatchapong / springboot-example-service

Example RESTful APIs Service for Spring Boot

🥾 Spring-Boot Example Service

Minimal example Spring Boot application

⚙️ Prerequisites

The followings are needed to build, test and run the project.

• JDK 11 or OpenJDK 11
• Maven 3
• Docker

Dependencies:

• Spring Web 🕸️
• Spring Data JPA 📓
• Spring Validation 💪
• Spring Boot DevTools ⚒️
• Lombok 🌶️
• H2 Database 🗄️
• JUnit 5 🧪
• Mockito 🍸

🚗 Getting Started

Follow the below instructions to build, test and run the project on your local machine.

Clone

Get started by cloning this repository using git command.

git clone [email protected]:Wanatchapong/springboot-example-service.git

Compile

And compile the project using the following maven command.

mvn compile 

Build jar file

And build the project jar file using the following maven command.

mvn package 

Test

Unit test project using the following maven command.

mvn test

Run

Run project using the following maven command.

mvn spring-boot:run

or run from the jar file

java -jar target/<projectname-version>.jar 

🐳 Docker

1. Compile source code and package it in its distribution format as JAR

mvn package

2. Build docker image and tag the name of image name:tag. If not pass a tag, Docker uses "latest" as its default tag.

docker build -t springboot-example-service .

3. Run docker image in detached mode

docker run -d -p 8080:8080 -t springboot-example-service

🚀 Try it out

Open a terminal then make a GET request to the server using the curl command.

curl --request GET \
--url http://localhost:8080/todo \
--header 'content-type: application/json'