https://github.com/dhutchison/microprofile-experiments
https://github.com/dhutchison/microprofile-experiments
microprofile
Last synced: 16 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/dhutchison/microprofile-experiments
- Owner: dhutchison
- License: mit
- Created: 2019-06-05T20:02:32.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-05-07T23:22:20.000Z (over 1 year ago)
- Last Synced: 2025-01-18T00:31:27.821Z (12 months ago)
- Topics: microprofile
- Language: Java
- Size: 114 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://depshield.github.io)
# MicroProfile generated Application
## Introduction
MicroProfile Starter has generated this MicroProfile application for you.
The generation of the executable jar file can be performed by issuing the following command
mvn clean package
This will create an executable jar file **experiments-microbundle.jar** within the _target_ maven folder. This can be started by executing the following command
java -jar target/experiments-microbundle.jar
To launch the test page, open your browser at the following URL
http://localhost:8080/index.html
## Introduction 2
(Really should write a decent readme here...)
# My OSS Project
This project was later updated to include content from the [ModiTect OSS Quickstart](https://github.com/moditect/oss-quickstart) archetype.
Run the following command to build this project:
```
mvn clean verify
```
Pass the `-Dquick` option to skip all non-essential plug-ins and create the output artifact as quickly as possible:
```
mvn clean verify -Dquick
```
Run the following command to format the source code and organize the imports as per the project's conventions:
```
mvn process-sources
```
## Blog Post Series
This generated application is being extended as I learn more about MicroProfile.
The starter to this blog post series is available [here](https://www.devwithimagination.com/2019/08/18/eclipse-microprofile/).
## 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](https://microprofile.io/)
### Config
Configuration of your application parameters. Specification [here](https://microprofile.io/project/eclipse/microprofile-config)
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](https://microprofile.io/project/eclipse/microprofile-fault-tolerance)
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](https://microprofile.io/project/eclipse/microprofile-health)
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](https://microprofile.io/project/eclipse/microprofile-metrics)
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](https://microprofile.io/project/eclipse/microprofile-rest-client)
Have a look at the **JWTClient** class which calls the protected endpoint on the server from a Java Main method.
The **ProtectedController** contains the protected endpoint since it contains the _@RolesAllowed_ annotation on the JAX-RS endppoint method.
### Open API
Exposes the information about your endpoints in the format of the OpenAPI v3 specification. Specification [here](https://microprofile.io/project/eclipse/microprofile-open-api)
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](https://microprofile.io/project/eclipse/microprofile-opentracing)
Example needs to be created.
### Rest Client
A type safe invocation of HTTP rest endpoints. Specification [here](https://microprofile.io/project/eclipse/microprofile-rest-client)
Example needs to be created.