Red Hat Summit Red Hat SummitApoyoConsolaDesarrolladoresIniciar una pruebaContacto

Este contenido no está disponible en el idioma seleccionado.

Chapter 94. YAML DSL

Since Camel 3.9

The YAML DSL provides the capability to define your Camel routes, route templates & REST DSL configuration in YAML.

94.1. Defining a route
Copiar enlace

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"
Copy to Clipboard Toggle word wrap

Where,

1
Route entry point, by default from and rest are supported.
2
Processing steps
Note

Each step represents a YAML map that has a single entry where the field name is the EIP name.

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

  • Output Aware Steps

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"
Copy to Clipboard Toggle word wrap
  • Expression Aware Steps

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

Explicit Expression field

filter:
  expression:
    simple: "${in.header.continue} == true"
Copy to Clipboard Toggle word wrap

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

Implicit Expression field

filter:
  simple: "${in.header.continue} == true"
Copy to Clipboard Toggle word wrap

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.

Full Expression definition

filter:
  tokenize:
    token: "<"
    end-token: ">"
Copy to Clipboard Toggle word wrap

  • Data Format Aware Steps

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

marshal:
  json:
    library: Gson
Copy to Clipboard Toggle word wrap
Note

In case you want to use the data-format’s default settings, you need to place an empty block as data format parameters, like json: {}

94.2. Defining endpoints
Copiar enlace

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

  • Using a classic Camel URI: 
- from:
    uri: "timer:tick?period=1s"
    steps:
      - to:
          uri: "telegram:bots?authorizationToken=XXX"
Copy to Clipboard Toggle word wrap
  • Using URI and parameters: 
- from:
    uri: "timer://tick"
    parameters:
      period: "1s"
    steps:
      - to:
          uri: "telegram:bots"
          parameters:
            authorizationToken: "XXX"
Copy to Clipboard Toggle word wrap

94.3. Defining beans
Copiar enlace

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
Copy to Clipboard Toggle word wrap

Where,

1
The name of the bean which will bound the instance to the Camel Registry.
2
The full qualified class name of the bean
3
The properties of the bean to be set

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'
Copy to Clipboard Toggle word wrap
Note

The beans elements is only used as root element.

94.4. Configuring options on languages
Copiar enlace

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"
Copy to Clipboard Toggle word wrap

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"
  }
}
Copy to Clipboard Toggle word wrap

94.5. External examples
Copiar enlace

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.

Volver arriba
Red Hat logoGithubredditYoutubeTwitter

Aprender

Pruebe, compre y venda

Comunidades

Acerca de la documentación de Red Hat

Ayudamos a los usuarios de Red Hat a innovar y alcanzar sus objetivos con nuestros productos y servicios con contenido en el que pueden confiar. Explore nuestras recientes actualizaciones.

Hacer que el código abierto sea más inclusivo

Red Hat se compromete a reemplazar el lenguaje problemático en nuestro código, documentación y propiedades web. Para más detalles, consulte el Blog de Red Hat.

Acerca de Red Hat

Ofrecemos soluciones reforzadas que facilitan a las empresas trabajar en plataformas y entornos, desde el centro de datos central hasta el perímetro de la red.

Theme

© 2025 Red Hat