Skip to content

Latest commit

 

History

History
48 lines (43 loc) · 1.62 KB

README.md

File metadata and controls

48 lines (43 loc) · 1.62 KB
Raw

Quarkus Config Extension

Adds a servlet to a Quarkus application running in development mode which lists the configured values for MicroProfile Configuration. The servlet is registered using the path /config by default and lists all properties of all config sources. The config sources are sorted descending by ordinal, the properties by name. If no config is defined an empty JSON object is returned.

A typical output might look like:

{
  "sources": [
    {
      "source": "SysPropConfigSource",
      "ordinal": 400,
      "properties": {
        "file.encoding": "UTF-8",
        "file.separator": "/"
      }
    },
    {
      "source": "EnvConfigSource",
      "ordinal": 300,
      "properties": {
        "EDITOR": "vim",
        "LC_ALL": "en_US.UTF-8"
      }
    },
    {
      "source": "PropertiesConfigSource[source=resource:META-INF/microprofile-config.properties]",
      "ordinal": 100,
      "properties": {
        "greeting.message": "hello",
        "greeting.name": "quarkus"
      }
    }
  ]
}

To use the extension in your Quarkus app, add the following dependency to your pom.xml (the config extension is not available in Maven Central. For now you have to clone the repository and install the extension in your local maven repository.)

<dependency>
    <groupId>io.quarkus</groupId>
    <artifactId>quarkus-config</artifactId>
    <version>${quarkus.config.version}</version>
    <scope>provided</scope>
</dependency>

Please note that due to security reasons, the extension is only available in development mode.