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/ .
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
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/.
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.
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
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.
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.
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.
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)
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.
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.
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.
To deploy the demo app on a docker-compose please visit ./deploy
Populate default pets
curl -X GET "http://0.0.0.0:8080/v1/pets/populate-defaults" -H "accept: application/json"
Add a new pet
curl -X POST "http://0.0.0.0:8080/v1/pets/add" -H "accept: application/json" -H "Content-Type: application/json" -d "{\"pet_age\":1,\"pet_id\":1,\"pet_name\":\"Bubbles\",\"pet_type\":\"Fish \"}"
Get pet by ID
curl -X GET "http://0.0.0.0:8080/v1/pets/1" -H "accept: application/json"
Get all pets
curl -X GET "http://0.0.0.0:8080/v1/pets" -H "accept: application/json"
Search pets by age
curl -X GET "http://0.0.0.0:8080/v1/pets?age=1" -H "accept: application/json"
Search pets by name
curl -X GET "http://0.0.0.0:8080/v1/pets?name=Bubbles" -H "accept: application/json"
Search pets by type
curl -X GET "http://0.0.0.0:8080/v1/pets?type=Fish" -H "accept: application/json"
Search pets by any combination of age, name or type (omit query params as needed)
curl -X GET "http://0.0.0.0:8080/v1/pets?age=1&name=Bubbles&type=Fish" -H "accept: application/json"
Update pet by ID
curl -X PUT "http://0.0.0.0:8080/v1/pets/update/1" -H "accept: application/json" -H "Content-Type: application/json" -d "{\"pet_age\":1,\"pet_id\":2,\"pet_name\":\"Gini\",\"pet_type\":\"Cat\"}"
Delete pet by ID
curl -X DELETE "http://0.0.0.0:8080/v1/pets/delete/1" -H "accept: application/json"
Populate default pet types
curl -X GET "http://0.0.0.0:8080/v1/pet-types/populate-defaults" -H "accept: application/json"
Add a new pet type
curl -X POST "http://0.0.0.0:8080/v1/pet-types/add" -H "accept: application/json" -H "Content-Type: application/json" -d "{\"pet_type_id\":1,\"pet_type_name\":\"Turtle\"}"
Get pet type by ID
curl -X GET "http://0.0.0.0:8080/v1/pet-types/1" -H "accept: application/json"
Get all pet types
curl -X GET "http://0.0.0.0:8080/v1/pet-types" -H "accept: application/json"
Update pet type by ID
curl -X PUT "http://0.0.0.0:8080/v1/pet-types/update/1" -H "accept: application/json" -H "Content-Type: application/json" -d "{\"pet_type_id\":2,\"pet_type_name\":\"Monkey\"}"
Delete pet type by ID
curl -X DELETE "http://0.0.0.0:8080/v1/pet-types/delete/1" -H "accept: application/json"
Run test suite using,
./gradlew test
Test results can be accessed at,
./build/reports/tests/test/index.html