-
Class Summary
Class |
Description |
YamlProcessor |
A processor using Jackson and SnakeYaml to read Yaml files.
|
Package io.vertx.config.yaml Description
=== Yaml Configuration Format
The Yaml Configuration Format extends the Vert.x Configuration Retriever and provides the
support for the Yaml Configuration Format format.
==== Using the Yaml Configuration Format
To use the Yaml Configuration Format, add the following dependency to the
_dependencies_ section of your build descriptor:
* Maven (in your `pom.xml`):
[source,xml,subs="+attributes"]
----
${maven.groupId}
${maven.artifactId}
${maven.version}
${maven.groupId}
vertx-config
${maven.version}
----
* Gradle (in your `build.gradle` file):
[source,groovy,subs="+attributes"]
----
compile '${maven.groupId}:vertx-config:${maven.version}'
compile '${maven.groupId}:${maven.artifactId}:${maven.version}'
----
==== Configuring the store to use YAML
Once added to your classpath or dependencies, you need to configure the
ConfigRetriever
to use this format:
[source, $lang]
----
examples.Examples#example1(io.vertx.core.Vertx)
----
You just need to set `format` to `yaml`.