• Home
• io.vertx
• vertx-config-yaml
• 4.5.1
• source code

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

x-config-yaml.4.5.1.source-code.yaml-format.adoc Maven / Gradle / Ivy

=== 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"]
----

  io.vertx
  vertx-config-yaml
  ${maven.version}


  io.vertx
  vertx-config
  ${maven.version}

----

* Gradle (in your `build.gradle` file):

[source,groovy,subs="+attributes"]
----
compile 'io.vertx:vertx-config:${maven.version}'
compile 'io.vertx:vertx-config-yaml:${maven.version}'
----

==== Configuring the store to use YAML

Once added to your classpath or dependencies, you need to configure the
{@link io.vertx.config.ConfigRetriever} to use this format:

[source, $lang]
----
{@link examples.ConfigYamlExamples#example1(io.vertx.core.Vertx)}
----

You just need to set `format` to `yaml`.