Create a Simple CRUD REST API using Quarkus
Just several days ago, Quarkus release version 2.0, providing more features and some more improvements in this release. In this tutorial, we’ll try to see how can we use the latest Quarkus version to create a simple rest api, which is connect to an existing MySQL database by using hibernate.
Lets start with a simple pom.xml file,
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.edw</groupId>
<artifactId>hello-world-quarkus</artifactId>
<version>1.0-SNAPSHOT</version>
<properties>
<compiler-plugin.version>3.8.1</compiler-plugin.version>
<maven.compiler.parameters>true</maven.compiler.parameters>
<maven.compiler.source>11</maven.compiler.source>
<maven.compiler.target>11</maven.compiler.target>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
<quarkus.platform.artifact-id>quarkus-universe-bom</quarkus.platform.artifact-id>
<quarkus.platform.group-id>io.quarkus</quarkus.platform.group-id>
<quarkus.platform.version>2.0.0.Final</quarkus.platform.version>
<surefire-plugin.version>3.0.0-M5</surefire-plugin.version>
</properties>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>${quarkus.platform.group-id}</groupId>
<artifactId>${quarkus.platform.artifact-id}</artifactId>
<version>${quarkus.platform.version}</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>
<dependencies>
<dependency>
<groupId>io.quarkus</groupId>
<artifactId>quarkus-hibernate-orm</artifactId>
</dependency>
<dependency>
<groupId>io.quarkus</groupId>
<artifactId>quarkus-resteasy</artifactId>
</dependency>
<dependency>
<groupId>io.quarkus</groupId>
<artifactId>quarkus-resteasy-jsonb</artifactId>
</dependency>
<dependency>
<groupId>io.quarkus</groupId>
<artifactId>quarkus-jdbc-mysql</artifactId>
</dependency>
<dependency>
<groupId>io.quarkus</groupId>
<artifactId>quarkus-arc</artifactId>
</dependency>
<dependency>
<groupId>io.quarkus</groupId>
<artifactId>quarkus-junit5</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>io.rest-assured</groupId>
<artifactId>rest-assured</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>${quarkus.platform.group-id}</groupId>
<artifactId>quarkus-maven-plugin</artifactId>
<version>${quarkus.platform.version}</version>
<extensions>true</extensions>
<executions>
<execution>
<goals>
<goal>build</goal>
<goal>generate-code</goal>
<goal>generate-code-tests</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin>
<artifactId>maven-compiler-plugin</artifactId>
<version>${compiler-plugin.version}</version>
<configuration>
<parameters>${maven.compiler.parameters}</parameters>
</configuration>
</plugin>
<plugin>
<artifactId>maven-surefire-plugin</artifactId>
<version>${surefire-plugin.version}</version>
<configuration>
<systemPropertyVariables>
<java.util.logging.manager>org.jboss.logmanager.LogManager</java.util.logging.manager>
<maven.home>${maven.home}</maven.home>
</systemPropertyVariables>
</configuration>
</plugin>
</plugins>
</build>
<profiles>
<profile>
<id>native</id>
<activation>
<property>
<name>native</name>
</property>
</activation>
<build>
<plugins>
<plugin>
<artifactId>maven-failsafe-plugin</artifactId>
<version>${surefire-plugin.version}</version>
<executions>
<execution>
<goals>
<goal>integration-test</goal>
<goal>verify</goal>
</goals>
<configuration>
<systemPropertyVariables>
<native.image.path>
${project.build.directory}/${project.build.finalName}-runner
</native.image.path>
<java.util.logging.manager>org.jboss.logmanager.LogManager
</java.util.logging.manager>
<maven.home>${maven.home}</maven.home>
</systemPropertyVariables>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>
<properties>
<quarkus.package.type>native</quarkus.package.type>
</properties>
</profile>
</profiles>
</project>
Next is creating a simple java model, as table representation
package com.edw.model;
import javax.persistence.*;
import java.math.BigDecimal;
import java.util.Date;
@Entity
@Table(name = "T_TRANSFER")
public class Transfer {
@Id
@GeneratedValue(strategy= GenerationType.AUTO)
private Long id;
private String accountFrom;
private String accountTo;
private Date transferDate;
private BigDecimal amount;
public Transfer() {
}
public Long getId() {
return id;
}
public void setId(Long id) {
this.id = id;
}
public String getAccountFrom() {
return accountFrom;
}
public void setAccountFrom(String accountFrom) {
this.accountFrom = accountFrom;
}
public String getAccountTo() {
return accountTo;
}
public void setAccountTo(String accountTo) {
this.accountTo = accountTo;
}
public Date getTransferDate() {
return transferDate;
}
public void setTransferDate(Date transferDate) {
this.transferDate = transferDate;
}
public BigDecimal getAmount() {
return amount;
}
public void setAmount(BigDecimal amount) {
this.amount = amount;
}
}
After that we can create a simple class for querying using EntityManager,
package com.edw.service;
import com.edw.dto.TransferDto;
import com.edw.model.Transfer;
import javax.enterprise.context.ApplicationScoped;
import javax.inject.Inject;
import javax.persistence.EntityManager;
import javax.transaction.Transactional;
import java.util.Date;
import java.util.HashMap;
import java.util.List;
@Transactional
@ApplicationScoped
public class TransferService {
@Inject
EntityManager em;
public List<Transfer> findAll() {
return em.createQuery("select t from Transfer t", Transfer.class).getResultList();
}
public Long create(TransferDto transferDto) {
Transfer transfer = new Transfer();
transfer.setAccountFrom(transferDto.getAccountFrom());
transfer.setAccountTo(transferDto.getAccountTo());
transfer.setAmount(transferDto.getAmount());
transfer.setTransferDate(new Date());
em.persist(transfer);
return transfer.getId();
}
}
And a controller to handle rest api request,
package com.edw.controller;
import com.edw.dto.TransferDto;
import com.edw.service.TransferService;
import javax.inject.Inject;
import javax.ws.rs.GET;
import javax.ws.rs.POST;
import javax.ws.rs.Path;
import javax.ws.rs.Produces;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;
import java.util.HashMap;
@Path("/transfer")
public class TransferController {
@Inject
TransferService transferService;
@GET
@Path("/")
@Produces(MediaType.APPLICATION_JSON)
public Response findAll() {
return Response
.ok(transferService.findAll())
.build();
}
@POST
@Path("/")
@Produces(MediaType.APPLICATION_JSON)
public Response create(TransferDto transferDto) {
try {
Long id = transferService.create(transferDto);
return Response // 200
.ok(
new HashMap() {{
put("id", id);
}})
.build();
} catch (Exception ex) {
return Response // error 400
.status(400).entity(
new HashMap() {{
put("error", "failed to insert");
}})
.build();
}
}
}
Last step is configuring our database connection in application.properties file
quarkus.datasource.jdbc.url=jdbc:mysql://192.168.1.1:3306/db_test quarkus.datasource.jdbc.driver=com.mysql.cj.jdbc.Driver quarkus.datasource.jdbc.max-size=20 quarkus.datasource.jdbc.min-size=2 quarkus.datasource.username=root quarkus.datasource.password=password quarkus.hibernate-orm.database.generation=update
Finally, we can start our Quarkus app by running below command,
$ mvn compile quarkus:dev
And use curl to check whether API is accessible or not.
$ curl -L -X POST 'http://localhost:8080/transfer/' \
-H 'Content-Type: application/json' \
--data-raw '{
"accountFrom":"4444",
"accountTo": "55555",
"amount" : 50000
}'
The full code for this can be accessed on below github link
https://github.com/edwin/quarkus-hello-world
Have fun with Quarkus 🙂
