JSonApi

Since Camel 3.0

The JSonApi dataformat supports 3 options, which are listed below.

Name Default Java Type Description

dataFormatTypes

Class[]

The classes to take into account for the marshalling

mainFormatType

Class

The classes to take into account while unmarshalling

contentTypeHeader

false

Boolean

Whether the data format should set the Content-Type header with the type from the data format if the data format is capable of doing so. For example application/xml for data formats marshalling to XML, or application/json for data formats marshalling to JSON etc.

Dependencies

To use JsonAPI in your camel routes you need to add the dependency on camel-jsonapi which implements this data format.

If you use maven you could just add the following to your pom.xml, substituting the version number for the latest & greatest release (see the download page for the latest versions).

<dependency>
  <groupId>org.apache.camel</groupId>
  <artifactId>camel-jsonapi</artifactId>
  <version>x.x.x</version>
  <!-- use the same version as your Camel core version -->
</dependency>

Spring Boot Auto-Configuration

When using jsonapi with Spring Boot make sure to use the following Maven dependency to have support for auto configuration:

<dependency>
  <groupId>org.apache.camel.springboot</groupId>
  <artifactId>camel-jsonapi-starter</artifactId>
  <version>x.x.x</version>
  <!-- use the same version as your Camel core version -->
</dependency>

The component supports 4 options, which are listed below.

Name Description Default Type

camel.dataformat.jsonapi.content-type-header

Whether the data format should set the Content-Type header with the type from the data format if the data format is capable of doing so. For example application/xml for data formats marshalling to XML, or application/json for data formats marshalling to JSON etc.

false

Boolean

camel.dataformat.jsonapi.data-format-types

The classes to take into account for the marshalling

Class[]

camel.dataformat.jsonapi.enabled

Whether to enable auto configuration of the jsonApi data format. This is enabled by default.

Boolean

camel.dataformat.jsonapi.main-format-type

The classes to take into account while unmarshalling

Class
Back to top