https://github.com/kmacedovarela/observable-service
https://github.com/kmacedovarela/observable-service
Last synced: 7 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/kmacedovarela/observable-service
- Owner: kmacedovarela
- Created: 2022-06-29T07:32:09.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-07-06T16:24:22.000Z (over 3 years ago)
- Last Synced: 2025-03-20T07:06:21.340Z (7 months ago)
- Language: Java
- Size: 10.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# 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 **observable-service.jar** within the _target_ maven folder. This can be started by executing the following command
java -jar target/observable-service.jar
To launch the test page, open your browser at the following URL
http://localhost:8080/index.html
## 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.
### 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)
### 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.