PetStore Application

Introduction

MicroProfile Starter has generated this MicroProfile application for you.

This project uses Quarkus, the Supersonic Subatomic Java Framework.

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

Packaging and running the application

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

./gradlew build -Dquarkus.package.type=uber-jar

To run the application:

java -jar build/petstore-runner.jar

The application can be also packaged using simple:

./gradlew build

It produces the quarkus-run.jar file in the build/quarkus-app/ directory. Be aware that it is not an ??ber-jar as the dependencies are copied into the build/quarkus-app/lib/ directory.

To launch the test page, open your browser at the following URL

http://localhost:8080/index.html

Running the application in dev mode

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

./gradlew quarkusDev

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

Creating a native executable

Mind having GRAALVM_HOME set to your Mandrel or GraalVM installation.

You can create a native executable using:

./gradlew build -Dquarkus.package.type=native

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

./gradlew build -Dquarkus.package.type=native -Dquarkus.native.container-build=true

Or to use Mandrel distribution:

./gradlew build -Dquarkus.package.type=native -Dquarkus.native.container-build=true -Dquarkus.native.builder-image=quay.io/quarkus/ubi-quarkus-mandrel:20.3-java11

You can then execute your native executable with:

./build/petstore-runner

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

Specification examples

By default, there is always the creation of a JAX-RS application class to define the path on which the JAX-RS endpoints are available.

Also, a simple Hello world endpoint is created, have a look at the class HelloController.

More information on MicroProfile can be found here

Config

Configuration of your application parameters. Specification here

The example class ConfigTestController shows you how to inject a configuration parameter and how you can retrieve it programmatically.

Fault tolerance

Add resilient features to your applications like TimeOut, RetryPolicy, Fallback, bulkhead and circuit breaker. Specification here

The example class ResilienceController has an example of a FallBack mechanism where an fallback result is returned when the execution takes too long.

Health

The health status can be used to determine if the 'computing node' needs to be discarded/restarted or not. Specification here

The class ServiceHealthCheck contains an example of a custom check which can be integrated to health status checks of the instance. The index page contains a link to the status data.

Metrics

The Metrics exports Telemetric data in a uniform way of system and custom resources. Specification here

The example class MetricController contains an example how you can measure the execution time of a request. The index page also contains a link to the metric page (with all metric info)

JWT Auth

Using the OpenId Connect JWT token to pass authentication and authorization information to the JAX-RS endpoint. Specification here

Have a look at the TestSecureController class which calls the protected endpoint on the secondary application. The ProtectedController (secondary application) contains the protected endpoint since it contains the @RolesAllowed annotation on the JAX-RS endpoint method.

The TestSecureController code creates a JWT based on the private key found within the resource directory. However, any method to send a REST request with an appropriate header will work of course. Please feel free to change this code to your needs.

Open API

Exposes the information about your endpoints in the format of the OpenAPI v3 specification. Specification here

The index page contains a link to the OpenAPI information of your endpoints.

Open Tracing

Allow the participation in distributed tracing of your requests through various micro services. Specification here

To show this capability download Jaeger and run ./jaeger-all-in-one. Open http://localhost:16686/ to see the traces. Mind that you have to access your demo app endpoint for any traces to show on Jaeger UI.

Deploying Application

To deploy the demo app on a docker-compose please visit ./deploy

Test the Application

By running the Test Suite

Here we use the JUnit Test Suite to execute our tests. If you want to manually test the application execute the following command:

./gradlew test

By running cURL

Resource : Pet Type

Get all pet types

curl http://localhost:8080/v1/petTypes/ -H "Accept: application/json" 

Add new pet types

curl -X POST http://localhost:8080/v1/petTypes/add -H 'Content-Type: application/json' -d '{"petTypeId": 6, "petTypeName": "Butterfly"},'

Update pet type

curl -X PUT http://localhost:8080/v1/petTypes/update/3 -H 'Content-Type: application/json' -d '{"petTypeId": 3, "petTypeName": "Guinea Pig"},'

Delete pet type

curl -X DELETE http://localhost:8080/v1/petTypes/delete/3 

Resource : Pet

Get all pets

curl http://localhost:8080/v1/pets/ -H "Accept: application/json" 

Add new pet

curl -X POST http://localhost:8080/v1/pets/add -H 'Content-Type: application/json' -d '{"petId": 7, "petAge": 1,"petName": "Katuchuty","petType": "Lizard"}'

Update pet

curl -X PUT http://localhost:8080/v1/pets/update/3 -H 'Content-Type: application/json' -d '{"petId": 3, "petAge": 134,"petName": "Bolt","petType": "Tortoise"}'

Delete pet

curl -X DELETE http://localhost:8080/v1/pets/delete/3