This project uses Quarkus, the Supersonic Subatomic Java Framework.

If you want to learn more about Quarkus, please visit its website: https://quarkus.io/ .

• Java 17
• Maven 3.9
• Docker 24
• Kubectl 1.28
• Minikube 1.31

To run app locally it's required to start a postgres instance separately, e.g. with docker container:

docker run --name my-postgres-container -e POSTGRES_USER=myuser -e POSTGRES_PASSWORD=mypassword -e POSTGRES_DB=payments -d -p 5432:5432 postgres:15.4

You can run your application in dev mode that enables live coding using:

./mvnw compile quarkus:dev

NOTE: Quarkus now ships with a Dev UI, which is available in dev mode only at http://localhost:8080/q/dev/.

All endpoints require basic authorization. For testing purpose we have a few users automatically pre-configured.

curl --location 'http://localhost:8080/payments' \
--header 'Authorization: Basic am9objpqb2hu' \
--header 'Content-Type: application/json' \
--data '{
    "amount": 11.13, 
    "currency": "USD", 
    "name": "Test Consumer"
  }'

curl  --header 'Authorization: Basic am9objpqb2hu' http://localhost:8080/payments

curl --head --header 'Authorization: Basic am9objpqb2hu' -X DELETE http://localhost:8080/payments/{id}

For a testing purpose, there are shell scripts to work with the app in a kubernetes cluster using minikube.

Please, refer to requirements for installation guidance.

chmod +x scripts/* (required only once)

./scripts/start-minikube.sh

First, find application's pod name with: kubectl get pods

Then, forward its port via: kubectl port-forward ${container-name} 8080:8080

After minikube cluster is started, just run in any terminal (and leave it running while you want to use ingress)

minikube tunnel 

Then, you can access service via http://payments-app.com, e.g.

curl --header 'Authorization: Basic am9objpqb2hu' http://payments-app.com/payments

./scripts/stop-minikube.sh

./scripts/re-deploy.sh

You can check app logs in minikube with: kubectl logs deployments/payments-demo-quarkus-app

The application can be packaged using:

./mvnw package

It produces the quarkus-run.jar file in the target/quarkus-app/ directory. Be aware that it’s not an über-jar as the dependencies are copied into the target/quarkus-app/lib/ directory.

The application is now runnable using java -jar target/quarkus-app/quarkus-run.jar.

If you want to build an über-jar, execute the following command:

./mvnw package -Dquarkus.package.type=uber-jar

The application, packaged as an über-jar, is now runnable using java -jar target/*-runner.jar.

You can create a native executable using:

./mvnw package -Dnative

Or, if you don't have GraalVM installed, you can run the native executable build in a container using:

./mvnw package -Dnative -Dquarkus.native.container-build=true

You can then execute your native executable with: ./target/payments-demo-quarkus-app-1.0.0-SNAPSHOT-runner

If you want to learn more about building native executables, please consult https://quarkus.io/guides/maven-tooling.

• Hibernate ORM (guide): Define your persistent model with Hibernate ORM and Jakarta Persistence
• JDBC Driver - PostgreSQL (guide): Connect to the PostgreSQL database via JDBC
• RESTEasy Classic JSON-B (guide): JSON-B serialization support for RESTEasy Classic

Create your first JPA entity

Related guide section...

Easily start your RESTful Web Services

Related guide section...