此内容没有您所选择的语言版本。

Chapter 157. Spark REST


Spark REST Component

Available as of Camel 2.14
The Spark-rest component allows to define REST endpoints using the Spark REST Java library using the Rest DSL.
Important
Spark Java requires Java 8 runtime.
Maven users will need to add the following dependency to their pom.xml for this component:
<dependency>
    <groupId>org.apache.camel</groupId>
    <artifactId>camel-spark-rest</artifactId>
    <version>${camel-version}</version>
</dependency>
Copy to Clipboard Toggle word wrap

URI format

spark-rest://verb:path?[options]
Copy to Clipboard Toggle word wrap

URI Options

Expand
Name
Default Value
Description
verb
get, post, put, patch, delete, head, trace, connect, or options.
path
the content path which support Spark syntax. See further below for examples.
accept
accept type such as: 'text/xml', or 'application/json'. By default we accept all kinds of types.

Path using Spark syntax

The path option is defined using a Spark REST syntax where you define the REST context path using support for parameters and splat. See more details at the Spark Java Route documentation.
The following is a Camel route using a fixed path
  from("spark-rest:get:hello")
    .transform().constant("Bye World");
Copy to Clipboard Toggle word wrap
And the following route uses a parameter which is mapped to a Camel header with the key "me".
  from("spark-rest:get:hello/:me")
    .transform().simple("Bye ${header.me}");
Copy to Clipboard Toggle word wrap

Mapping to Camel Message

The Spark Request object is mapped to a Camel Message as a org.apache.camel.component.sparkrest.SparkMessage which has access to the raw Spark request using the getRequest method. By default the Spark body is mapped to Camel message body, and any HTTP headers / Spark parameters is mapped to Camel Message headers. There is special support for the Spark splat syntax, which is mapped to the Camel message header with key splat.
For example the given route below uses Spark splat (the asterisk sign) in the context path which we can access as a header form the Simple language to construct a response message.
  from("spark-rest:get:/hello/*/to/*")
    .transform().simple("Bye big ${header.splat[1]} from ${header.splat[0]}");
Copy to Clipboard Toggle word wrap

Rest DSL

Apache Camel provides a new Rest DSL that allow to define the REST services in a nice REST style. For example we can define a REST hello service as shown below:
  return new RouteBuilder() {
      @Override
      public void configure() throws Exception {
            rest("/hello/{me}").get()
                .route().transform().simple("Bye ${header.me}");
        }
    };
Copy to Clipboard Toggle word wrap
  <camelContext xmlns="http://camel.apache.org/schema/spring">
    <rest uri="/hello/{me}">
      <get>
        <route>
          <transform>
            <simple>Bye ${header.me}</simple>
          </transform>
        </route>
      </get>
    </rest>
  </camelContext>
Copy to Clipboard Toggle word wrap
See more details at the Rest DSL.

More examples

There is a camel-example-spark-rest-tomcat example in the Apache Camel distribution, that demonstrates how to use camel-spark-rest in a web application that can be deployed on Apache Tomcat, or similar web containers.
返回顶部
Red Hat logoGithubredditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务,以及可以信赖的内容,帮助红帽用户创新并实现他们的目标。 了解我们当前的更新.

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情,请参阅红帽博客.

關於紅帽

我们提供强化的解决方案,使企业能够更轻松地跨平台和环境(从核心数据中心到网络边缘)工作。

Theme

© 2025 Red Hat