Sample Quarkus Application

Description

This application is a Quarkus implementation of the Values API application from sample-dotnet-app repository. The application was created by following the official guides published by Quarkus. The API exposes the following endpoints:

GET /api/values
POST /api/values (accepts a JSON string in request body)
GET /api/values/{id}
PUT /api/values/{id} (accepts a JSON string in request body)
DELETE /api/values/{id}

The API also comes with the following administrative endpoints:

GET /health (Overall healthcheck)
GET /health/live (Just the liveness healthcheck)
GET /health/ready (Just the readiness healthcheck)
GET /metrics (Prometheus compatible metrics)

In addition to the in memory mode available in the .NET version, this version also adds a persistent mode that stores values created via the API in a MySQL database.

Build

JVM image

    docker build -t sample-quarkus-app .

Native image

    docker build -f Dockerfile.native -t sample-quarkus-app .

Run Locally

In memory version

    docker run -d \
        --name sample-quarkus-app \
        -p 8080:8080 \
        sample-quarkus-app

Persistent version

First run MySQL in a container. $REPO below refers to the full path to wherever you cloned this repository.

    export REPO=`pwd` && docker run -d \
        --name valuesdb \
        -e MYSQL_ROOT_PASSWORD=password \
        -v $REPO/database/values.sql:/docker-entrypoint-initdb.d/values.sql:Z \
        -p 3306:3306 \
        mysql:8.0.19

After MySQL is up and running, run the persistent version of API. $HOST_IP below refers to the IP address of the machine running these containers. This assumes the API container can reach the MySQL container using the host IP.

    docker run -d \
        --name sample-quarkus-app \
        -e SAMPLE_STORAGE_TYPE=persistent \
        -e QUARKUS_DATASOURCE_URL="jdbc:mysql://$HOST_IP:3306/valsdb" \
        -e QUARKUS_DATASOURCE_USERNAME=valsuser \
        -e QUARKUS_DATASOURCE_PASSWORD=password \
        -p 8080:8080 \
        sample-quarkus-app

Consume

Following is an example flow to use the web service. NOTE: The host:port value of localhost:8080 below is based on the application being deployed using Run Locally section above. Change the value as needed when consuming the application that has been deployed using other means.

Health Check
```
  curl -i localhost:8080/health
```

Prometheus compatible metrics

  curl -i -H "Accept: application/json" \
          localhost:8080/metrics

Create a value

  curl -i -X POST \
          -H "Content-Type: application/json" \
          -d '"My Original Value"' \
          localhost:8080/api/values

Fetch all stored values
```
  curl -i localhost:8080/api/values
```

Change value

  curl -i -X PUT \
          -H "Content-Type: application/json" \
          -d '"My Changed Value"' \
          localhost:8080/api/values/1

Fetch value by ID
```
  curl -i localhost:8080/api/values/1
```

Delete value by ID

  curl -i -X DELETE \
          localhost:8080/api/values/1

Companion Blog

See my blog article Enter Quarkus for a background on Quarkus and more information about this application.

saharsh-samples/sample-quarkus-app