Chapter 11. Adding YAML configuration support

Procedure

1. Open the src/main/resources/application.yaml configuration file.

2. Add the nested class configuration properties to your application.yaml file as shown in the example:

   src/main/resources/application.yaml

   # Properties that configure the JDBC data source driver of your PostgreSQL data source
   quarkus:
     datasource:
       url: jdbc:postgresql://localhost:5432/some-database
       driver: org.postgresql.Driver
       username: quarkus
       password: quarkus
   
   # Property that configures the URL of the endpoint to which the rest client sends requests
   org:
     acme:
       restclient:
         CountriesService/mp-rest/url: https://restcountries.eu/rest
   
   # Property that configures the log message level for your application
   quarkus:
     log:
       category:
         # Do not use spaces in names of configuration properties that you place inside quotation marks
         "io.quarkus.category":
           level: INFO

   Copy to Clipboard Toggle word wrap

   Note, that you can use comments to describe your configuration properties in a similar way as you use them in application.properties.

   Note

   Always use spaces to indent the properties in your YAML configuration file. YAML does not allow using tabs for indentation.

Procedure

1. Open the src/main/resources/application.yaml configuration file.

2. To set a profile dependent configuration, add the profile name before defining the key-value pairs using the "%<profile_name>" syntax. Ensure that you place the profile name inside quotation marks. In YAML, all strings that begin with a special character must be placed inside quotation marks.

   In the following example the PostgreSQL database is configured to be available at the jdbc:postgresql://localhost:5432/some-database URL when you start your Quarkus application in development mode:

   src/main/resources/application.yaml

   "%dev":
     # Properties that configure the JDBC data source driver of your PostgreSQL data source
     quarkus:
       datasource:
         url: jdbc:postgresql://localhost:5432/some-database
         driver: org.postgresql.Driver
         username: quarkus
         password: quarkus

   Copy to Clipboard Toggle word wrap

Procedure

1. Open your YAML configuration file.

2. To define a YAML property as a prefix of another property, add a tilde (~) in the scope of the property as shown in the following example:

   quarkus:
     http:
       cors:
         ~: true
         methods: GET,PUT,POST

   Copy to Clipboard Toggle word wrap

3. To compile your Quarkus application in development mode, enter the following command from the project directory:

   ./mvnw quarkus:dev

   Copy to Clipboard Toggle word wrap
   Note

   You can use YAML keys for conflicting configuration keys at any level because they are not included in the assembly of configuration property name.