Modified: websites/production/camel/content/rest-dsl.html
==============================================================================
--- websites/production/camel/content/rest-dsl.html (original)
+++ websites/production/camel/content/rest-dsl.html Tue Jul 21 08:22:06 2015
@@ -86,115 +86,126 @@
<tr>
<td valign="top" width="100%">
<div class="wiki-content maincontent"><h2 id="RestDSL-RestDSL">Rest
DSL</h2><p><strong>Available as of Camel 2.14</strong></p><p>Apache Camel
offers a REST styled DSL which can be used with Java or XML. The intention is
to allow end users to define REST services using a REST style with verbs such
as get, post, delete etc.</p><h4 id="RestDSL-Howitworks">How it
works</h4><p>The Rest DSL is a facade that builds <a shape="rect"
href="rest.html">Rest</a> endpoints as consumers for Camel routes. The
actual REST transport is leveraged by using Camel REST components such
as <a shape="rect" href="restlet.html">Restlet</a>, <a shape="rect"
href="spark-rest.html">Spark-rest</a>, and others that has native REST
integration.</p><h3 id="RestDSL-ComponentssupportingRestDSL">Components
supporting Rest DSL</h3><p>The following Camel components supports the Rest
DSL. See the bottom of this page for how to integrate a component with the Rest
DSL.</p><ul><li><a shape="rect" href="netty-h
ttp.html">camel-netty-http</a></li><li><a shape="rect"
href="jetty.html">camel-jetty</a></li><li><a shape="rect"
href="restlet.html">camel-restlet</a></li><li><a shape="rect"
href="servlet.html">camel-servlet</a></li><li><a shape="rect"
href="spark-rest.html">camel-spark-rest</a></li></ul><h3
id="RestDSL-RestDSLwithJava">Rest DSL with Java</h3><p>To use the Rest DSL in
Java then just do as with regular Camel routes by extending
the <code>RouteBuilder</code> and define the routes in
the <code>configure</code> method.</p><p>A simple REST service can be
define as follows, where we use rest() to define the services as shown
below:</p><div class="code panel pdl" style="border-width: 1px;"><div
class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default"
style="font-size:12px;"> protected RouteBuilder createRouteBuilder() throws
Exception {
+<script class="brush: java; gutter: false; theme: Default"
type="syntaxhighlighter"><![CDATA[ protected RouteBuilder
createRouteBuilder() throws Exception {
return new RouteBuilder() {
@Override
public void configure() throws Exception {
- rest("/say")
- .get("/hello").to("direct:hello")
- .get("/bye").consumes("application/json").to("direct:bye")
- .post("/bye").to("mock:update");
-
- from("direct:hello")
- .transform().constant("Hello World");
- from("direct:bye")
- .transform().constant("Bye World");
+ rest("/say")
+ .get("/hello").to("direct:hello")
+
.get("/bye").consumes("application/json").to("direct:bye")
+ .post("/bye").to("mock:update");
+
+ from("direct:hello")
+ .transform().constant("Hello World");
+ from("direct:bye")
+ .transform().constant("Bye World");
}
};
- }</pre>
+ }]]></script>
</div></div><p> </p><p>This defines a REST service with the following url
mappings:</p><div class="table-wrap"><table
class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1"
class="confluenceTh">Base Path</th><th colspan="1" rowspan="1"
class="confluenceTh">Uri template</th><th colspan="1" rowspan="1"
class="confluenceTh">Verb</th><th colspan="1" rowspan="1"
class="confluenceTh">Consumes</th></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p><span>/say</span></p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>/hello</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>get</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><em>all</em></p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p>/say</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>/bye</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>get</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>application/json</p></td></tr><tr><td colspa
n="1" rowspan="1" class="confluenceTd"><p>/say</p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>/bye</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>post</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><em>all</em></p></td></tr></tbody></table></div><p>Notice
that in the REST service we route directly to a Camel endpoint using the to().
This is because the Rest DSL has a short-hand for routing directly to an
endpoint using to(). An alternative is to embed a Camel route directly using
route() - there is such an example further below.</p><h3
id="RestDSL-RestDSLwithXML">Rest DSL with XML</h3><p>The REST DSL supports the
XML DSL also using either Spring or Blueprint. The example above can be define
in XML as shown below:</p><div class="code panel pdl" style="border-width:
1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default"
style="font-size:12px;"> <camelContext
xmlns="http://camel.apache.org/schema/spring">
- <rest path="/say">
- <get uri="/hello">
- <to uri="direct:hello"/>
+<script class="brush: java; gutter: false; theme: Default"
type="syntaxhighlighter"><![CDATA[ <camelContext
xmlns="http://camel.apache.org/schema/spring">
+ <rest path="/say">
+ <get uri="/hello">
+ <to uri="direct:hello"/>
</get>
- <get uri="/bye" consumes="application/json">
- <to uri="direct:bye"/>
+ <get uri="/bye" consumes="application/json">
+ <to uri="direct:bye"/>
</get>
- <post uri="/bye">
- <to uri="mock:update"/>
+ <post uri="/bye">
+ <to uri="mock:update"/>
</post>
</rest>
<route>
- <from uri="direct:hello"/>
+ <from uri="direct:hello"/>
<transform>
<constant>Hello World</constant>
</transform>
</route>
<route>
- <from uri="direct:bye"/>
+ <from uri="direct:bye"/>
<transform>
<constant>Bye World</constant>
</transform>
</route>
- </camelContext></pre>
+ </camelContext>]]></script>
</div></div><p> </p><h3 id="RestDSL-Usingbasepath">Using base
path</h3><p>The REST DSL allows to define base path to make the DSL a bit more
DRY. For example to define a customer path, we can set the base path in
rest("/customer") and then provide the uri templates in the verbs, as shown
below:</p><div class="code panel pdl" style="border-width: 1px;"><div
class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default"
style="font-size:12px;"> rest("/customers/")
- .get("/{id}").to("direct:customerDetail")
- .get("/{id}/orders").to("direct:customerOrders")
- .post("/neworder").to("direct:customerNewOrder");
+<script class="brush: java; gutter: false; theme: Default"
type="syntaxhighlighter"><![CDATA[ rest("/customers/")
+ .get("/{id}").to("direct:customerDetail")
+ .get("/{id}/orders").to("direct:customerOrders")
+ .post("/neworder").to("direct:customerNewOrder");
-</pre>
+]]></script>
</div></div><p> </p><p>And using XML DSL it becomes:</p><div class="code
panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default"
style="font-size:12px;"> <rest path="/customers/">
- <get uri="/{id}">
- <to uri="direct:customerDetail"/>
+<script class="brush: java; gutter: false; theme: Default"
type="syntaxhighlighter"><![CDATA[ <rest path="/customers/">
+ <get uri="/{id}">
+ <to uri="direct:customerDetail"/>
</get>
- <get uri="/{id}/orders">
- <to uri="direct:customerOrders"/>
+ <get uri="/{id}/orders">
+ <to uri="direct:customerOrders"/>
</get>
- <post uri="/neworder">
- <to uri="direct:customerNewOrder"/>
+ <post uri="/neworder">
+ <to uri="direct:customerNewOrder"/>
</post>
- </rest></pre>
+ </rest>]]></script>
</div></div><div class="confluence-information-macro
confluence-information-macro-tip"><span class="aui-icon aui-icon-small
aui-iconfont-approve confluence-information-macro-icon"></span><div
class="confluence-information-macro-body"><p>The REST DSL will take care of
duplicate path separators when using base path and uri templates. In the
example above the rest base path ends with a slash ( / ) and the verb starts
with a slash ( / ). But Apache Camel will take care of this and remove the
duplicated slash.</p></div></div><p>It is not required to use both base path
and uri templates. You can omit the bast path and define the base path and uri
template in the verbs only. The example above can be defined as:</p><div
class="code panel pdl" style="border-width: 1px;"><div class="codeContent
panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default"
style="font-size:12px;"> <rest>
- <get uri="/customers/{id}">
- <to uri="direct:customerDetail"/>
+<script class="brush: java; gutter: false; theme: Default"
type="syntaxhighlighter"><![CDATA[ <rest>
+ <get uri="/customers/{id}">
+ <to uri="direct:customerDetail"/>
</get>
- <get uri="/customers/{id}/orders">
- <to uri="direct:customerOrders"/>
+ <get uri="/customers/{id}/orders">
+ <to uri="direct:customerOrders"/>
</get>
- <post uri="/customers/neworder">
- <to uri="direct:customerNewOrder"/>
+ <post uri="/customers/neworder">
+ <to uri="direct:customerNewOrder"/>
</post>
- </rest></pre>
-</div></div><h3 id="RestDSL-EmbeddingCamelroutes">Embedding Camel
routes</h3><p>Each of the rest service becomes a Camel route, so in the
first example we have 2 x get and 1 x post REST service, which each become a
Camel route. And we have 2 regular Camel routes, meaning we have 3 + 2 = 5
routes in total. </p><p>There are two route modes with the Rest
DSL</p><ul><li><span style="line-height: 1.4285715;">mini using a singular
to</span></li><li><span style="line-height: 1.4285715;">embedding a Camel route
using route </span></li></ul><p><span style="line-height: 1.4285715;">The
first example is using the former with a singular to. And that is why we end up
with 3 + 2 = 5 total routes.</span></p><p><span style="line-height:
1.4285715;">The same example could use embedded Camel routes, which is shown
below:</span></p><div class="code panel pdl" style="border-width: 1px;"><div
class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default"
style="font-size:12px;"> protected RouteBuilder createRouteBuilder() throws
Exception {
+ </rest>]]></script>
+</div></div><h3 id="RestDSL-UsingDynamicTo">Using Dynamic
To</h3><p><strong>Available as of Camel 2.16</strong></p><p>The <a
shape="rect" href="rest-dsl.html">Rest DSL</a> supports the new .toD
<toD> as dynamic to in the rest-dsl. For example to do a request/reply
over <a shape="rect" href="jms.html">JMS</a> where the queue name is
dynamic defined</p><div class="code panel pdl" style="border-width: 1px;"><div
class="codeContent panelContent pdl">
+<script class="brush: xml; gutter: false; theme: Default"
type="syntaxhighlighter"><![CDATA[ public void configure() throws Exception {
+ rest("/say")
+
.get("/hello/{language}").toD("jms:queue:hello-${header.language}");
+}]]></script>
+</div></div><h3 id="RestDSL-AndinXMLDSL">And in XML DSL</h3><div class="code
panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<script class="brush: xml; gutter: false; theme: Default"
type="syntaxhighlighter"><![CDATA[<rest uri="/say">
+ <get uri="/hello//{language}">
+ <toD uri="jms:queue:hello-${header.language}"/>
+ </get>
+<rest>]]></script>
+</div></div><p> </p><p>See more details at <a shape="rect"
href="message-endpoint.html">Message Endpoint</a> about the dynamic to, and
what syntax it supports. By default it uses the <a shape="rect"
href="simple.html">Simple</a> language, but it has more power than so.</p><h3
id="RestDSL-EmbeddingCamelroutes">Embedding Camel routes</h3><p>Each of the
rest service becomes a Camel route, so in the first example we have 2 x
get and 1 x post REST service, which each become a Camel route. And we have 2
regular Camel routes, meaning we have 3 + 2 = 5 routes in
total. </p><p>There are two route modes with the Rest DSL</p><ul><li><span
style="line-height: 1.4285715;">mini using a singular to</span></li><li><span
style="line-height: 1.4285715;">embedding a Camel route using
route </span></li></ul><p><span style="line-height: 1.4285715;">The first
example is using the former with a singular to. And that is why we end up with
3 + 2 = 5 total routes.</span></p><p><
span style="line-height: 1.4285715;">The same example could use embedded Camel
routes, which is shown below:</span></p><div class="code panel pdl"
style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<script class="brush: java; gutter: false; theme: Default"
type="syntaxhighlighter"><![CDATA[ protected RouteBuilder
createRouteBuilder() throws Exception {
return new RouteBuilder() {
@Override
public void configure() throws Exception {
- rest("/say/hello")
- .get().route().transform().constant("Hello World");
- rest("/say/bye")
-
.get().consumes("application/json").route().transform().constant("Bye
World").endRest()
- .post().to("mock:update");
+ rest("/say/hello")
+ .get().route().transform().constant("Hello
World");
+ rest("/say/bye")
+
.get().consumes("application/json").route().transform().constant("Bye
World").endRest()
+ .post().to("mock:update");
};
- }</pre>
+ }]]></script>
</div></div><p><span style="line-height: 1.4285715;">In the example above, we
are embedding routes directly in the rest service using .route(). Notice we
need to use .endRest() to tell Camel where the route ends, so we
can <em>go back</em> to the Rest DSL and continue defining REST
services.</span></p><div class="confluence-information-macro
confluence-information-macro-tip"><p class="title">Configuring route
options</p><span class="aui-icon aui-icon-small aui-iconfont-approve
confluence-information-macro-icon"></span><div
class="confluence-information-macro-body"><p>In the embedded route you can
configure the route settings such as routeId, autoStartup and various other
options you can set on routes
today.</p><pre>.get().route().routeId("myRestRoute").autoStartup(false).transform().constant("Hello
World");</pre></div></div><h3 id="RestDSL-ManagingRestservices"><span
style="font-size: 16.0px;line-height: 1.5625;">Managing Rest
services</span></h3><p>Each of the rest service bec
omes a Camel route, so in the first example we have 2 x get and 1 x post REST
service, which each become a Camel route. This makes it <em>the same</em>
from Camel to manage and run these services - as they are just Camel routes.
This means any tooling and API today that deals with Camel routes, also work
with the REST services.</p><p>This means you can use JMX to stop/start routes,
and also get the JMX metrics about the routes, such as number of message
processed, and their performance statistics.</p><p>There is also a Rest
Registry JMX MBean that contains a registry of all REST services which has been
defined. </p><h3 id="RestDSL-BindingtoPOJOsusing">Binding to POJOs
using</h3><p>The Rest DSL supports automatic binding json/xml contents to/from
POJOs using Camels <a shape="rect" href="data-format.html">Data
Format</a>. By default the binding mode is off, meaning there is no automatic
binding happening for incoming and outgoing messages.</p><p>You may want to use
bind
ing if you develop POJOs that maps to your REST services request and response
types. This allows you as a developer to work with the POJOs in Java
code.</p><p>The binding modes are:</p><div class="table-wrap"><table
class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1"
class="confluenceTh">Binding Mode</th><th colspan="1" rowspan="1"
class="confluenceTh">Description</th></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p>off</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>Binding is turned off. This is the default
option.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p>auto</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>Binding is enabled and Camel is relaxed and support
json, xml or both if the needed data formats are included in the classpath.
Notice that if for example <code>camel-jaxb</code> is not on the classpath,
then XML binding is not enabled.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p
>json</p></td><td colspan="1" rowspan="1" class="confluenceTd"><p>Binding
>to/from json is enabled, and requires a json capabile data format on the
>classpath. By default Camel will use <code>json-jackson</code> as the data
>format.</p></td></tr><tr><td colspan="1" rowspan="1"
>class="confluenceTd"><p>xml</p></td><td colspan="1" rowspan="1"
>class="confluenceTd"><p>Binding to/from xml is enabled, and requires
><code>camel-jaxb</code> on the classpath.</p></td></tr><tr><td colspan="1"
>rowspan="1" class="confluenceTd"><p>json_xml</p></td><td colspan="1"
>rowspan="1" class="confluenceTd"><p>Biding to/from json and xml is enabled
>and requires both data formats to be on the
>classpath.</p></td></tr></tbody></table></div><div
>class="confluence-information-macro confluence-information-macro-tip"><span
>class="aui-icon aui-icon-small aui-iconfont-approve
>confluence-information-macro-icon"></span><div
>class="confluence-information-macro-body"><p>From <strong>Camel
>2.14.1</strong> onwards when using c
amel-jaxb for xml bindings, then you can use the option
<code>mustBeJAXBElement</code> to relax the output message body must be a class
with JAXB annotations. You can use this in situations where the message body is
already in XML format, and you want to use the message body as-is as the output
type. If that is the case, then set the <span>dataFormatProperty option
<code>mustBeJAXBElement</code><span> to <code>false</code>
value.</span></span></p></div></div><p> </p><p>To use binding you must
include the necessary data formats on the classpath, such
as <code>camel-jaxb</code> and/or <code>camel-jackson</code>. And
then enable the binding mode. You can configure the binding mode globally on
the rest configuration, and then override per rest service as well.</p><p>To
enable binding you configure this in Java DSL as shown below</p><div
class="code panel pdl" style="border-width: 1px;"><div class="codeContent
panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default"
style="font-size:12px;">restConfiguration().component("restlet").host("localhost").port(portNum).bindingMode(RestBindingMode.auto);</pre>
+<script class="brush: java; gutter: false; theme: Default"
type="syntaxhighlighter"><![CDATA[restConfiguration().component("restlet").host("localhost").port(portNum).bindingMode(RestBindingMode.auto);]]></script>
</div></div><p>And in XML DSL</p><div class="code panel pdl"
style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default"
style="font-size:12px;"> <restConfiguration bindingMode="auto"
component="restlet" port="8080"/></pre>
+<script class="brush: java; gutter: false; theme: Default"
type="syntaxhighlighter"><![CDATA[ <restConfiguration
bindingMode="auto" component="restlet"
port="8080"/>]]></script>
</div></div><p> </p><p>When binding is enabled Camel will bind the
incoming and outgoing messages automatic, accordingly to the content type of
the message. If the message is json, then json binding happens; and so if the
message is xml then xml binding happens. The binding happens for incoming and
reply messages. The table below summaries what binding occurs for incoming and
reply messages. </p><div class="table-wrap"><table
class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1"
class="confluenceTh">Message Body</th><th colspan="1" rowspan="1"
class="confluenceTh">Direction</th><th colspan="1" rowspan="1"
class="confluenceTh">Binding Mode</th><th colspan="1" rowspan="1"
class="confluenceTh">Message Body</th></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p>XML</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>Incoming</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>auto<br clear="none">xml<br
clear="none">json_xml </p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>POJO</p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p>POJO</p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>Outgoing</p></td><td colspan="1"
rowspan="1"
class="confluenceTd"><p>auto</p><p>xml</p><p>json_xml </p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>XML</p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p>JSON</p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>Incoming</p></td><td colspan="1"
rowspan="1"
class="confluenceTd"><p>auto</p><p>json</p><p>json_xml </p></td><td
colspan="1" rowspan="1" class="confluenceTd"><p>POJO</p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p>POJO</p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>Outgoing</p></td><td colspan="1"
rowspan="1"
class="confluenceTd"><p>auto</p><p>json</p><p>json_xml </p></td><td
colspan="1" rowspan="1"
class="confluenceTd"><p>JSON</p></td></tr></tbody></table><
/div><p> </p><p>When using binding you must also configure what POJO type
to map to. This is mandatory for incoming messages, and optional for
outgoing. </p><p>For example to map from xml/json to a pojo
class <code>UserPojo</code> you do this in Java DSL as shown
below:</p><div class="code panel pdl" style="border-width: 1px;"><div
class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default"
style="font-size:12px;">// configure to use restlet on localhost with the given
port
+<script class="brush: java; gutter: false; theme: Default"
type="syntaxhighlighter"><![CDATA[// configure to use restlet on localhost with
the given port
// and enable auto binding mode
-restConfiguration().component("restlet").host("localhost").port(portNum).bindingMode(RestBindingMode.auto);
+restConfiguration().component("restlet").host("localhost").port(portNum).bindingMode(RestBindingMode.auto);
// use the rest DSL to define the rest services
-rest("/users/")
+rest("/users/")
.post().type(UserPojo.class)
- .to("direct:newUser");</pre>
+ .to("direct:newUser");]]></script>
</div></div><p>Notice we use <code>type</code> to define the incoming
type. We can optionally define an outgoing type (which can be a good idea, to
make it known from the DSL and also for tooling and JMX APIs to know both the
incoming and outgoing types of the REST services.). To define the outgoing
type, we use <code>outType</code> as shown below:</p><div class="code
panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default"
style="font-size:12px;">// configure to use restlet on localhost with the given
port
+<script class="brush: java; gutter: false; theme: Default"
type="syntaxhighlighter"><![CDATA[// configure to use restlet on localhost with
the given port
// and enable auto binding mode
-restConfiguration().component("restlet").host("localhost").port(portNum).bindingMode(RestBindingMode.auto);
+restConfiguration().component("restlet").host("localhost").port(portNum).bindingMode(RestBindingMode.auto);
// use the rest DSL to define the rest services
-rest("/users/")
+rest("/users/")
.post().type(UserPojo.class).outType(CountryPojo.class)
- .to("direct:newUser");</pre>
+ .to("direct:newUser");]]></script>
</div></div><p><span style="line-height: 1.4285715;"><br
clear="none"></span></p><p><span style="line-height:
1.4285715;">The </span><code style="line-height:
1.4285715;">UserPojo</code><span style="line-height: 1.4285715;"> is just a
plain pojo with getter/setter as shown:</span></p><div class="code panel pdl"
style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default"
style="font-size:12px;">public class UserPojo {
+<script class="brush: java; gutter: false; theme: Default"
type="syntaxhighlighter"><![CDATA[public class UserPojo {
private int id;
private String name;
public int getId() {
@@ -209,9 +220,9 @@ rest("/users/")
public void setName(String name) {
this.name = name;
}
-}</pre>
+}]]></script>
</div></div><p>The <code>UserPojo</code> only supports json, as XML
requires to use JAXB annotations, so we can add those annotations if we want to
support XML also</p><div class="code panel pdl" style="border-width: 1px;"><div
class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default"
style="font-size:12px;">@XmlRootElement(name = "user")
+<script class="brush: java; gutter: false; theme: Default"
type="syntaxhighlighter"><![CDATA[@XmlRootElement(name = "user")
@XmlAccessorType(XmlAccessType.FIELD)
public class UserPojo {
@XmlAttribute
@@ -232,81 +243,81 @@ public class UserPojo {
}
}
-</pre>
+]]></script>
</div></div><p>By having the JAXB annotations the POJO supports both json and
xml bindings.</p><h3 id="RestDSL-ConfiguringRestDSL"><span style="line-height:
1.5625;">Configuring Rest DSL</span></h3><p>The Rest DSL allows to configure
the following options using a builder style</p><div class="table-wrap"><table
class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1"
class="confluenceTh">Option</th><th colspan="1" rowspan="1"
class="confluenceTh">Default</th><th colspan="1" rowspan="1"
class="confluenceTh">Description</th></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p>component</p></td><td colspan="1" rowspan="1"
class="confluenceTd"> </td><td colspan="1" rowspan="1"
class="confluenceTd"><p>The Camel Rest component to use for the REST transport,
such as restlet, spark-rest. If no component has been explicit configured, then
Camel will lookup if there is a Camel component that integrates with the Rest
DSL, or if a <code>org.apache.camel.spi.RestConsumerFa
ctory</code> is registered in the registry. If either one is found, then
that is being used.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p>scheme</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>http</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>The scheme to use for exposing the REST service.
Usually http or https is supported</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p>hostname</p></td><td colspan="1" rowspan="1"
class="confluenceTd"> </td><td colspan="1" rowspan="1"
class="confluenceTd"><p>The hostname to use for exposing the REST
service.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p>port</p></td><td colspan="1" rowspan="1"
class="confluenceTd"> </td><td colspan="1" rowspan="1"
class="confluenceTd"><p>The port number to use for exposing the REST service.
Notice if you use servlet component then the port number configured here does
not apply, as the port number in use is
the actual port number the servlet component is using. eg if using Apache
Tomcat its the tomcat http port, if using Apache Karaf its the HTTP service in
Karaf that uses port 8181 by default etc. Though in those situations setting
the port number here, allows tooling and JMX to know the port number, so its
recommended to set the port number to the number that the servlet engine
uses.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p>contextPath</p></td><td colspan="1" rowspan="1"
class="confluenceTd"> </td><td colspan="1" rowspan="1"
class="confluenceTd"><p>Sets a leading context-path the REST services will be
using. This can be used when using components such as <a shape="rect"
href="servlet.html">SERVLET</a> where the deployed web application is deployed
using a context-path.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p>restHostNameResolver</p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>localHostName</p></td><td colspan=
"1" rowspan="1" class="confluenceTd"><p>If no hostname has been explicit
configured, then this resolver is used to compute the hostname the REST service
will be using. The resolver supports <code>localHostName</code> or
<code>localIp</code>.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p>bindingMode</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>off</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>Whether binding is in use. See further above for more
details.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p>skipBindingOnErrorCode</p></td><td colspan="1"
rowspan="1" class="confluenceTd"><p>true</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><strong>Camel 2.14.1</strong>: Whether to skip binding
on output if there is a custom HTTP error code header. This allows to build
custom error messages that do not bind to json / xml etc, as success messages
otherwise will do. See further below for an example.</p></td>
</tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p>enableCORS</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p>false</p></td><td colspan="1" rowspan="1"
class="confluenceTd"><p><strong>Camel 2.14.1:</strong> Whether to enable CORS
headers in the HTTP response.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p>jsonDataFormat</p></td><td colspan="1" rowspan="1"
class="confluenceTd"> </td><td colspan="1" rowspan="1"
class="confluenceTd"><p>Name of specific json data format to use. By default
<code>json-jackson</code> will be used. <strong>Important:</strong> This option
is only for setting a custom name of the data format, not to refer to an
existing data format instance. <strong>Notice:</strong> Currently Jackson is
what we recommend and are using for testing.</p></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd"><p>xmlDataFormat</p></td><td colspan="1"
rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" clas
s="confluenceTd"><p>Name of specific XML data format to use. By default
<code>jaxb</code> will be used. <strong>Important:</strong><span> This option
is only for setting a custom name of the data format, not to refer to an
existing data format instance. </span><strong>Notice:</strong> Currently only
<code>jaxb</code> is supported.</p></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p>componentProperty</p></td><td colspan="1" rowspan="1"
class="confluenceTd"> </td><td colspan="1" rowspan="1"
class="confluenceTd"><p>Allows to configure as many additional properties. This
is used to configure component specific options such as for <a
shape="rect" href="restlet.html">Restlet</a> / <a shape="rect"
href="spark-rest.html">Spark-Rest</a> etc.</p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p>endpointProperty</p></td><td
colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1"
rowspan="1" class="confluenceTd"><p><span>
Allows to configure as many additional properties. This is used to configure
endpoint specific options for <span> </span><a shape="rect"
href="restlet.html">Restlet</a><span> / </span><a shape="rect"
href="spark-rest.html">Spark-Rest</a><span> etc.</span></span></p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p>consumerProperty</p></td><td
colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1"
rowspan="1" class="confluenceTd"><p><span>Allows to configure as many
additional properties. This is used to configure consumer specific options for
</span><span> </span><a shape="rect"
href="restlet.html">Restlet</a><span> / </span><a shape="rect"
href="spark-rest.html">Spark-Rest</a><span> etc.</span></p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p>dataFormatProperty</p></td><td
colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1"
rowspan="1" class="confluenceTd"><p>Allows to c
onfigure as many additional properties. This is used to configure the data
format specific options. For example set property prettyPrint to true to have
json outputted in pretty mode. From <strong>Camel 2.14.1</strong> onwards the
keys can be prefixed with either</p><ul style="list-style-type:
square;"><li><p>json.in.</p></li><li><p>json.out.</p></li><li><p>xml.in.</p></li><li><p>xml.out.</p></li></ul><p>to
denote that the option is only for either JSON or XML data format, and only
for either the in or the out going. For example a key with value
"xml.out.mustBeJAXBElement" is only for the XML data format for the outgoing. A
key without a prefix is a common key for all situations.</p></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd"><p>corsHeaderProperty</p></td><td
colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1"
rowspan="1" class="confluenceTd"><p>Allows to configure custom CORS
headers.</p></td></tr></tbody></table></div><p> </p><p><span st
yle="line-height: 1.4285715;">For example to configure to use the spark-rest
component on port 9091, then we can do as follows</span></p><div class="code
panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default"
style="font-size:12px;">restConfiguration().component("spark-rest").port(9091).componentProperty("foo",
"123");</pre>
+<script class="brush: java; gutter: false; theme: Default"
type="syntaxhighlighter"><![CDATA[restConfiguration().component("spark-rest").port(9091).componentProperty("foo",
"123");]]></script>
</div></div><p><span style="line-height: 1.4285715;"><br
clear="none"></span></p><p><span style="line-height: 1.4285715;">And with XML
DSL</span></p><div class="code panel pdl" style="border-width: 1px;"><div
class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default"
style="font-size:12px;"><restConfiguration component="spark-rest"
port="9091"> <componentProperty key="foo" value="123"/>
</restConfiguration></pre>
+<script class="brush: java; gutter: false; theme: Default"
type="syntaxhighlighter"><![CDATA[<restConfiguration
component="spark-rest" port="9091">
<componentProperty key="foo" value="123"/>
</restConfiguration>]]></script>
</div></div><p><span style="line-height: 1.4285715;"><br
clear="none"></span></p><p>You can configure properties on these
levels. </p><ul><li>component - Is used to set any options on the
Component class. You can also configure these directly on the
component.</li><li>endpoint - Is used set any option on the endpoint level.
Many of the Camel components has many options you can set on endpoint
level.</li><li>consumer - Is used to set any option on the consumer level. Some
components has consumer options, which you can also configure from endpoint
level by prefixing the option with "consumer." </li><li>data format - Is
used to set any option on the data formats. For example to enable pretty print
in the json data format.</li><li>cors headers - If cors is enabled, then custom
CORS headers can be set. See below for the default values which are in used. If
a custom header is set then that value takes precedence over the default
value.</li></ul><p>You can set multiple options of
the same level, so you can can for example configure 2 component options, and
3 endpoint options etc.</p><p> </p><h3
id="RestDSL-EnablingordisablingJacksonJSONfeatures">Enabling or disabling
Jackson JSON features</h3><p><strong>Available as of Camel
2.15</strong></p><p>When using JSON binding you may want to turn specific
Jackson features on or off. For example to disable failing on unknown
properties (eg json input has a property which cannot be mapped to a POJO) then
configure this using the dataFormatProperty as shown below:</p><div class="code
panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default"
style="font-size:12px;">restConfiguration().component("jetty").host("localhost").port(getPort()).bindingMode(RestBindingMode.json)
- .dataFormatProperty("json.in.disableFeatures",
"FAIL_ON_UNKNOWN_PROPERTIES");</pre>
+<script class="brush: java; gutter: false; theme: Default"
type="syntaxhighlighter"><![CDATA[restConfiguration().component("jetty").host("localhost").port(getPort()).bindingMode(RestBindingMode.json)
+ .dataFormatProperty("json.in.disableFeatures",
"FAIL_ON_UNKNOWN_PROPERTIES");]]></script>
</div></div><p>You can disable more features by separating the values using
comma, such as:</p><div class="code panel pdl" style="border-width: 1px;"><div
class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default"
style="font-size:12px;"> .dataFormatProperty("json.in.disableFeatures",
"FAIL_ON_UNKNOWN_PROPERTIES,ADJUST_DATES_TO_CONTEXT_TIME_ZONE");</pre>
+<script class="brush: java; gutter: false; theme: Default"
type="syntaxhighlighter"><![CDATA[
.dataFormatProperty("json.in.disableFeatures",
"FAIL_ON_UNKNOWN_PROPERTIES,ADJUST_DATES_TO_CONTEXT_TIME_ZONE");]]></script>
</div></div><p>Likewise you can enable features using the enableFeatures such
as:</p><div class="code panel pdl" style="border-width: 1px;"><div
class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default"
style="font-size:12px;">restConfiguration().component("jetty").host("localhost").port(getPort()).bindingMode(RestBindingMode.json)
- .dataFormatProperty("json.in.disableFeatures",
"FAIL_ON_UNKNOWN_PROPERTIES,ADJUST_DATES_TO_CONTEXT_TIME_ZONE")
- .dataFormatProperty("json.in.enableFeatures",
"FAIL_ON_NUMBERS_FOR_ENUMS,USE_BIG_DECIMAL_FOR_FLOATS");</pre>
+<script class="brush: java; gutter: false; theme: Default"
type="syntaxhighlighter"><![CDATA[restConfiguration().component("jetty").host("localhost").port(getPort()).bindingMode(RestBindingMode.json)
+ .dataFormatProperty("json.in.disableFeatures",
"FAIL_ON_UNKNOWN_PROPERTIES,ADJUST_DATES_TO_CONTEXT_TIME_ZONE")
+ .dataFormatProperty("json.in.enableFeatures",
"FAIL_ON_NUMBERS_FOR_ENUMS,USE_BIG_DECIMAL_FOR_FLOATS");]]></script>
</div></div><p>The values that can be used for enabling and disabling features
on Jackson are the names of the enums from the following three Jackson
classes</p><ul><li>com.fasterxml.jackson.databind.SerializationFeature</li><li>com.fasterxml.jackson.databind.DeserializationFeature</li><li>com.fasterxml.jackson.databind.MapperFeature</li></ul><p> </p><p>The
rest configuration is of course also possible using XML DSL</p><div
class="code panel pdl" style="border-width: 1px;"><div class="codeContent
panelContent pdl">
-<pre class="brush: xml; gutter: false; theme: Default"
style="font-size:12px;"><restConfiguration component="jetty"
host="localhost" port="9090" bindingMode="json">
- <dataFormatProperty key="json.in.disableFeatures"
value="FAIL_ON_UNKNOWN_PROPERTIES,ADJUST_DATES_TO_CONTEXT_TIME_ZONE"/>
- <dataFormatProperty key="json.in.enableFeatures"
value="FAIL_ON_NUMBERS_FOR_ENUMS,USE_BIG_DECIMAL_FOR_FLOATS"/>
-</restConfiguration></pre>
+<script class="brush: xml; gutter: false; theme: Default"
type="syntaxhighlighter"><![CDATA[<restConfiguration
component="jetty" host="localhost" port="9090"
bindingMode="json">
+ <dataFormatProperty key="json.in.disableFeatures"
value="FAIL_ON_UNKNOWN_PROPERTIES,ADJUST_DATES_TO_CONTEXT_TIME_ZONE"/>
+ <dataFormatProperty key="json.in.enableFeatures"
value="FAIL_ON_NUMBERS_FOR_ENUMS,USE_BIG_DECIMAL_FOR_FLOATS"/>
+</restConfiguration>]]></script>
</div></div><p> </p><h3 id="RestDSL-DefaultCORSheaders">Default CORS
headers</h3><p><strong>Available as of Camel 2.14.1</strong></p><p>If CORS is
enabled then the follow headers is in use by default. You can configure custom
CORS headers which takes precedence over the default value.</p><div
class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1"
rowspan="1" class="confluenceTh">Key</th><th colspan="1" rowspan="1"
class="confluenceTh">Value</th></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p>Access-Control-Allow-Origin</p></td><td colspan="1"
rowspan="1" class="confluenceTd">*</td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p>Access-Control-Allow-Methods</p></td><td colspan="1"
rowspan="1" class="confluenceTd">GET, HEAD, POST, PUT, DELETE, TRACE, OPTIONS,
CONNECT, PATCH</td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p>Access-Control-Allow-Headers</p></td><td colspan="1"
rowspan="1" class="confluenceTd">Origin, Ac
cept, X-Requested-With, Content-Type, Access-Control-Request-Method,
Access-Control-Request-Headers</td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd"><p>Access-Control-Max-Age</p></td><td colspan="1"
rowspan="1"
class="confluenceTd">3600</td></tr></tbody></table></div><p> </p><h3
id="RestDSL-Definingacustomerrormessageas-is">Defining a custom error message
as-is</h3><p>If you want to define custom error messages to be sent back to the
client with a HTTP error code (eg such as 400, 404 etc.) then
from <strong>Camel 2.14.1</strong> onwards you just set a header with the
key <code>Exchange.HTTP_RESPONSE_CODE</code> to the error code (must be
300+) such as 404. And then the message body with any reply message, and
optionally set the content-type header as well. There is a little example shown
below:</p><div class="code panel pdl" style="border-width: 1px;"><div
class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default"
style="font-size:12px;">
restConfiguration().component("restlet").host("localhost").port(portNum).bindingMode(RestBindingMode.json);
+<script class="brush: java; gutter: false; theme: Default"
type="syntaxhighlighter"><![CDATA[
restConfiguration().component("restlet").host("localhost").port(portNum).bindingMode(RestBindingMode.json);
// use the rest DSL to define the rest services
- rest("/users/")
-
.post("lives").type(UserPojo.class).outType(CountryPojo.class)
+ rest("/users/")
+
.post("lives").type(UserPojo.class).outType(CountryPojo.class)
.route()
.choice()
- .when().simple("${body.id} < 100")
- .bean(new UserErrorService(),
"idToLowError")
+ .when().simple("${body.id} < 100")
+ .bean(new UserErrorService(),
"idToLowError")
.otherwise()
- .bean(new UserService(),
"livesWhere");</pre>
+ .bean(new UserService(),
"livesWhere");]]></script>
</div></div><p>In this example if the input id is a number that is below 100,
we want to send back a custom error message, using the UserErrorService bean,
which is implemented as shown:</p><div class="code panel pdl"
style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default"
style="font-size:12px;">public class UserErrorService {
+<script class="brush: java; gutter: false; theme: Default"
type="syntaxhighlighter"><![CDATA[public class UserErrorService {
public void idToLowError(Exchange exchange) {
- exchange.getIn().setBody("id value is too low");
- exchange.getIn().setHeader(Exchange.CONTENT_TYPE, "text/plain");
+ exchange.getIn().setBody("id value is too low");
+ exchange.getIn().setHeader(Exchange.CONTENT_TYPE,
"text/plain");
exchange.getIn().setHeader(Exchange.HTTP_RESPONSE_CODE, 400);
}
-}</pre>
+}]]></script>
</div></div><p>In the UserErrorService bean we build our custom error message,
and set the HTTP error code to 400. This is important, as that tells rest-dsl
that this is a custom error message, and the message should not use the output
pojo binding (eg would otherwise bind to CountryPojo).</p><h3
id="RestDSL-CatchingJsonParserExceptionandreturningacustomerrormessage">Catching
JsonParserException and returning a custom error
message</h3><p>From <strong>Camel 2.14.1</strong> onwards you return a
custom message as-is (see previous section). So we can leverage this with Camel
error handler to catch JsonParserException, handle that exception and build our
custom response message. For example to return a HTTP error code 400 with a
hardcoded message, we can do as shown below:</p><div class="code panel pdl"
style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default"
style="font-size:12px;">onException(JsonParseException.class)
+<script class="brush: java; gutter: false; theme: Default"
type="syntaxhighlighter"><![CDATA[onException(JsonParseException.class)
.handled(true)
.setHeader(Exchange.HTTP_RESPONSE_CODE, constant(400))
- .setHeader(Exchange.CONTENT_TYPE, constant("text/plain"))
- .setBody().constant("Invalid json data");
+ .setHeader(Exchange.CONTENT_TYPE, constant("text/plain"))
+ .setBody().constant("Invalid json data");
-</pre>
+]]></script>
</div></div><p> </p><h3
id="RestDSL-IntegrationaCamelcomponentwithRestDSL">Integration a Camel
component with Rest DSL</h3><p>Any Apache Camel component can integrate with
the Rest DSL if they can be used as a REST service (eg as a REST consumer in
Camel lingo). To integrate with the Rest DSL, then the component should
implement the <code>org.apache.camel.spi.RestConsumerFactory</code>. The
Rest DSL will then invoke the <code>createConsumer</code> method when it
setup the Camel routes from the defined DSL. The component should then
implement logic to create a Camel consumer that exposes the REST services based
on the given parameters, such as path, verb, and other options. For example see
the source code for camel-restlet, camel-spark-rest.</p><h3
id="RestDSL-SwaggerAPI">Swagger API</h3><p>The Rest DSL supports <a
shape="rect" href="swagger.html">Swagger</a> by
the <code>camel-swagger</code> module. See more details at  <a
shape="rect" href="swagger.htm
l">Swagger</a> and
the <code>camel-example-servlet-rest-tomcat</code> example from the Apache
Camel distribution.</p><p>From <strong>Camel 2.16</strong> onwards you can
define each parameter fine grained with details such as name, description, data
type, parameter type and so on, using the <param>. For example to define
the id path parameter you can do as shown below:</p><div class="code panel pdl"
style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: xml; gutter: false; theme: Default"
style="font-size:12px;"><!-- this is a rest GET to view an user by the given
id -->
-<get uri="/{id}" outType="org.apache.camel.example.rest.User">
+<script class="brush: xml; gutter: false; theme: Default"
type="syntaxhighlighter"><![CDATA[<!-- this is a rest GET to view an user by
the given id -->
+<get uri="/{id}"
outType="org.apache.camel.example.rest.User">
<description>Find user by id</description>
- <param name="id" type="path" description="The id of the user to get"
dataType="int"/>
- <to uri="bean:userService?method=getUser(${header.id})"/>
-</get></pre>
+ <param name="id" type="path" description="The id
of the user to get" dataType="int"/>
+ <to uri="bean:userService?method=getUser(${header.id})"/>
+</get>]]></script>
</div></div><p>And in Java DSL</p><div class="code panel pdl"
style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default"
style="font-size:12px;">.get("/{id}").description("Find user by
id").outType(User.class)
- .param().name("id").type(path).description("The id of the user to
get").dataType("int").endParam()
- .to("bean:userService?method=getUser(${header.id})")</pre>
+<script class="brush: java; gutter: false; theme: Default"
type="syntaxhighlighter"><![CDATA[.get("/{id}").description("Find
user by id").outType(User.class)
+ .param().name("id").type(path).description("The id of the
user to get").dataType("int").endParam()
+ .to("bean:userService?method=getUser(${header.id})")]]></script>
</div></div><p>The body parameter type requires to use body as well for the
name. For example a REST PUT operation to create/update an user could be done
as:</p><div class="code panel pdl" style="border-width: 1px;"><div
class="codeContent panelContent pdl">
-<pre class="brush: xml; gutter: false; theme: Default"
style="font-size:12px;"><!-- this is a rest PUT to create/update an user
-->
-<put type="org.apache.camel.example.rest.User">
+<script class="brush: xml; gutter: false; theme: Default"
type="syntaxhighlighter"><![CDATA[<!-- this is a rest PUT to create/update
an user -->
+<put type="org.apache.camel.example.rest.User">
<description>Updates or create a user</description>
- <param name="body" type="body" description="The user to update or
create"/>
- <to uri="bean:userService?method=updateUser"/>
-</put></pre>
+ <param name="body" type="body" description="The
user to update or create"/>
+ <to uri="bean:userService?method=updateUser"/>
+</put>]]></script>
</div></div><p>And in Java DSL</p><div class="code panel pdl"
style="border-width: 1px;"><div class="codeContent panelContent pdl">
-<pre class="brush: java; gutter: false; theme: Default"
style="font-size:12px;">.put().description("Updates or create a
user").type(User.class)
- .param().name("body").type(body).description("The user to update or
create").endParam()
- .to("bean:userService?method=updateUser")</pre>
+<script class="brush: java; gutter: false; theme: Default"
type="syntaxhighlighter"><![CDATA[.put().description("Updates or create a
user").type(User.class)
+ .param().name("body").type(body).description("The user to
update or create").endParam()
+ .to("bean:userService?method=updateUser")]]></script>
</div></div><p> </p><p>For an example see
the <code>examples/camel-example-servlet-rest-tomcat</code> of the
Apache Camel distribution.</p><h3 id="RestDSL-SeeAlso">See Also</h3><ul><li><a
shape="rect" href="dsl.html">DSL</a></li><li><a shape="rect"
href="rest.html">Rest</a></li><li><a shape="rect"
href="swagger.html">Swagger</a></li><li><a shape="rect"
href="spark-rest.html">Spark-rest</a></li><li><a shape="rect"
href="how-do-i-import-rests-from-other-xml-files.html">How do I import rests
from other XML files</a></li></ul></div>
</td>
<td valign="top">
<div class="navigation">
<div class="navigation_top">
<!-- NavigationBar -->
-<div class="navigation_bottom" id="navigation_bottom"><h3
id="Navigation-Overviewhttps://cwiki.apache.org/confluence/pages/viewpage.action?pageId=49132";><a
shape="rect" href="overview.html">Overview</a></h3><ul
class="alternate"><li><a shape="rect" href="index.html">Home</a></li><li><a
shape="rect" href="download.html">Download</a></li><li><a shape="rect"
href="getting-started.html">Getting Started</a></li><li><a shape="rect"
href="faq.html">FAQ</a></li></ul><h3
id="Navigation-Documentationhttps://cwiki.apache.org/confluence/pages/viewpage.action?pageId=49534";><a
shape="rect" href="documentation.html">Documentation</a></h3><ul
class="alternate"><li><a shape="rect" href="user-guide.html">User
Guide</a></li><li><a shape="rect" href="manual.html">Manual</a></li><li><a
shape="rect" href="books.html">Books</a></li><li><a shape="rect"
href="tutorials.html">Tutorials</a></li><li><a shape="rect"
href="examples.html">Examples</a></li><li><a shape="rect"
href="cookbook.html">Cookbook</a></li>
<li><a shape="rect" href="architecture.html">Architecture</a></li><li><a
shape="rect" href="enterprise-integration-patterns.html">Enterprise Integration
Patterns</a></li><li><a shape="rect" href="dsl.html">DSL</a></li><li><a
shape="rect" href="components.html">Components</a></li><li><a shape="rect"
href="data-format.html">Data Format</a></li><li><a shape="rect"
href="languages.html">Languages</a></li><li><a shape="rect"
href="security.html">Security</a></li><li><a shape="rect"
href="security-advisories.html">Security Advisories</a></li></ul><h3
id="Navigation-Search">Search</h3><form
enctype="application/x-www-form-urlencoded" method="get" id="cse-search-box"
action="http://www.google.com/cse";>
+<div class="navigation_bottom" id="navigation_bottom"><h3
id="Navigation-Overview"><a shape="rect"
href="overview.html">Overview</a></h3><ul class="alternate"><li><a shape="rect"
href="index.html">Home</a></li><li><a shape="rect"
href="download.html">Download</a></li><li><a shape="rect"
href="getting-started.html">Getting Started</a></li><li><a shape="rect"
href="faq.html">FAQ</a></li></ul><h3 id="Navigation-Documentation"><a
shape="rect" href="documentation.html">Documentation</a></h3><ul
class="alternate"><li><a shape="rect" href="user-guide.html">User
Guide</a></li><li><a shape="rect" href="manual.html">Manual</a></li><li><a
shape="rect" href="books.html">Books</a></li><li><a shape="rect"
href="tutorials.html">Tutorials</a></li><li><a shape="rect"
href="examples.html">Examples</a></li><li><a shape="rect"
href="cookbook.html">Cookbook</a></li><li><a shape="rect"
href="architecture.html">Architecture</a></li><li><a shape="rect"
href="enterprise-integration-patterns.html">Enterprise
Integration Patterns</a></li><li><a shape="rect"
href="dsl.html">DSL</a></li><li><a shape="rect"
href="components.html">Components</a></li><li><a shape="rect"
href="data-format.html">Data Format</a></li><li><a shape="rect"
href="languages.html">Languages</a></li><li><a shape="rect"
href="security.html">Security</a></li><li><a shape="rect"
href="security-advisories.html">Security Advisories</a></li></ul><h3
id="Navigation-Search">Search</h3><form
enctype="application/x-www-form-urlencoded" method="get" id="cse-search-box"
action="http://www.google.com/cse";>
<div>
<input type="hidden" name="cx" value="007878419884033443453:m5nhvy4hmyq">
<input type="hidden" name="ie" value="UTF-8">
@@ -314,7 +325,7 @@ public class UserPojo {
<input type="submit" name="sa" value="Search">
</div>
</form>
-<script type="text/javascript"
src="http://www.google.com/coop/cse/brand?form=cse-search-box&lang=en";></script><h3
id="Navigation-Communityhttps://cwiki.apache.org/confluence/pages/viewpage.action?pageId=49115";><a
shape="rect" href="community.html">Community</a></h3><ul
class="alternate"><li><a shape="rect"
href="support.html">Support</a></li><li><a shape="rect"
href="contributing.html">Contributing</a></li><li><a shape="rect"
href="discussion-forums.html">Discussion Forums</a></li><li><a shape="rect"
href="mailing-lists.html">Mailing Lists</a></li><li><a shape="rect"
href="user-stories.html">User Stories</a></li><li><a shape="rect"
href="news.html">News</a></li><li><a shape="rect"
href="articles.html">Articles</a></li><li><a shape="rect"
href="site.html">Site</a></li><li><a shape="rect"
href="team.html">Team</a></li><li><a shape="rect" class="external-link"
href="http://camel-extra.googlecode.com/"; rel="nofollow">Camel
Extra</a></li></ul><h3 id="Navigation-Developershttps://cwi
ki.apache.org/confluence/pages/viewpage.action?pageId=49124"><a shape="rect"
href="developers.html">Developers</a></h3><ul class="alternate"><li><a
shape="rect" href="developers.html">Developer Guide</a></li><li><a shape="rect"
href="source.html">Source</a></li><li><a shape="rect"
href="building.html">Building</a></li><li><a shape="rect"
href="javadoc.html">JavaDoc</a></li><li><a shape="rect"
href="irc-room.html">IRC Room</a></li></ul><h3
id="Navigation-ApacheSoftwareFoundation">Apache Software Foundation</h3><ul
class="alternate"><li><a shape="rect" class="external-link"
href="http://www.apache.org/licenses/";>License</a></li><li><a shape="rect"
class="external-link"
href="http://www.apache.org/foundation/sponsorship.html";>Sponsorship</a></li><li><a
shape="rect" class="external-link"
href="http://www.apache.org/foundation/thanks.html";>Thanks</a></li><li><a
shape="rect" class="external-link"
href="http://www.apache.org/security/";>Security</a></li></ul></div>
+<script type="text/javascript"
src="http://www.google.com/coop/cse/brand?form=cse-search-box&lang=en";></script><h3
id="Navigation-Community"><a shape="rect"
href="community.html">Community</a></h3><ul class="alternate"><li><a
shape="rect" href="support.html">Support</a></li><li><a shape="rect"
href="contributing.html">Contributing</a></li><li><a shape="rect"
href="discussion-forums.html">Discussion Forums</a></li><li><a shape="rect"
href="mailing-lists.html">Mailing Lists</a></li><li><a shape="rect"
href="user-stories.html">User Stories</a></li><li><a shape="rect"
href="news.html">News</a></li><li><a shape="rect"
href="articles.html">Articles</a></li><li><a shape="rect"
href="site.html">Site</a></li><li><a shape="rect"
href="team.html">Team</a></li><li><a shape="rect" class="external-link"
href="http://camel-extra.googlecode.com/"; rel="nofollow">Camel
Extra</a></li></ul><h3 id="Navigation-Developers"><a shape="rect"
href="developers.html">Developers</a></h3><ul class="alternate"
><li><a shape="rect" href="developers.html">Developer Guide</a></li><li><a
>shape="rect" href="source.html">Source</a></li><li><a shape="rect"
>href="building.html">Building</a></li><li><a shape="rect"
>href="javadoc.html">JavaDoc</a></li><li><a shape="rect"
>href="irc-room.html">IRC Room</a></li></ul><h3
>id="Navigation-ApacheSoftwareFoundation">Apache Software Foundation</h3><ul
>class="alternate"><li><a shape="rect" class="external-link"
>href="http://www.apache.org/licenses/";>License</a></li><li><a shape="rect"
>class="external-link"
>href="http://www.apache.org/foundation/sponsorship.html";>Sponsorship</a></li><li><a
> shape="rect" class="external-link"
>href="http://www.apache.org/foundation/thanks.html";>Thanks</a></li><li><a
>shape="rect" class="external-link"
>href="http://www.apache.org/security/";>Security</a></li></ul></div>
<!-- NavigationBar -->
</div>
</div>
