Chapter 94. YAML DSL

A route is a collection of elements defined as follows:

- from: 1
    uri: "direct:start"
    steps: 2
      - filter:
          expression:
            simple: "${in.header.continue} == true"
          steps:
            - to:
                uri: "log:filtered"
      - to:
          uri: "log:original"

Where,

As a general rule, each step provides all the parameters the related definition declares, but there are some minor differences/enhancements:

Some steps, such as filter and split, have their own pipeline when an exchange matches the filter expression or for the items generated by the split expression. You can define these pipelines in the steps field:

filter:
  expression:
    simple: "${in.header.continue} == true"
    steps:
      - to:
          uri: "log:filtered"

Some EIP, such as filter and split, supports the definition of an expression through the expression field:

filter:
  expression:
    simple: "${in.header.continue} == true"

To make the DSL less verbose, you can omit the expression field.

filter:
  simple: "${in.header.continue} == true"

In general, expressions can be defined inline, such as within the examples above but if you need provide more information, you can 'unroll' the expression definition and configure any single parameter the expression defines.

filter:
  tokenize:
    token: "<"
    end-token: ">"

The EIP marshal and unmarshal supports the definition of data formats:

marshal:
  json:
    library: Gson

To define an endpoint with the YAML DSL you have two options:

- from:
    uri: "timer:tick?period=1s"
    steps:
      - to:
          uri: "telegram:bots?authorizationToken=XXX"

- from:
    uri: "timer://tick"
    parameters:
      period: "1s"
    steps:
      - to:
          uri: "telegram:bots"
          parameters:
            authorizationToken: "XXX"

In addition to the general support for creating beans provided by Camel Main, the YAML DSL provide a convenient syntax to define and configure them:

- beans:
  - name: beanFromMap  1
    type: com.acme.MyBean 2
    properties: 3
      foo: bar

Where,

The properties of the bean can be defined using either a map or properties style, as shown in the example below:

- beans:
  # map style
  - name: beanFromMap
    type: com.acme.MyBean
    properties:
      field1: 'f1'
      field2: 'f2'
      nested:
        field1: 'nf1'
        field2: 'nf2'
  # properties style
  - name: beanFromProps
    type: com.acme.MyBean
    properties:
      field1: 'f1_p'
      field2: 'f2_p'
      nested.field1: 'nf1_p'
      nested.field2: 'nf2_p'

Some languages have additional configurations that you may need to use.

For example, the JSONPath can be configured to ignore JSON parsing errors. This is intended when you use a Content Based Router and want to route the message to different endpoints. The JSON payload of the message can be in different forms, meaning that the JSonPath expressions in some cases would fail with an exception, and other times not. In this situation you must set suppress-exception to true, as shown below:

- from:
    uri: "direct:start"
    steps:
      - choice:
          when:
          - jsonpath:
              expression: "person.middlename"
              suppress-exceptions: true
            steps:
            - to: "mock:middle"
          - jsonpath:
              expression: "person.lastname"
              suppress-exceptions: true
            steps:
            - to: "mock:last"
          otherwise:
            steps:
              - to: "mock:other"

In the route above, the following message would have failed the JSonPath expression person.middlename because the JSON payload does not have a middlename field. To remedy this, we have suppressed the exception.

{
  "person": {
    "firstname": "John",
    "lastname": "Doe"
  }
}

You can find a set of examples using main-yaml in Camel examples that demonstrate how to create the Camel Routes with YAML. You can also refer to Camel Kamelets where each Kamelet is defined using YAML.