camel-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From build...@apache.org
Subject svn commit: r918932 - in /websites/production/camel/content: cache/main.pageCache rest-dsl.html swagger.html
Date Sun, 10 Aug 2014 10:17:52 GMT
Author: buildbot
Date: Sun Aug 10 10:17:52 2014
New Revision: 918932

Log:
Production update by buildbot for camel

Added:
    websites/production/camel/content/swagger.html
Modified:
    websites/production/camel/content/cache/main.pageCache
    websites/production/camel/content/rest-dsl.html

Modified: websites/production/camel/content/cache/main.pageCache
==============================================================================
Binary files - no diff available.

Modified: websites/production/camel/content/rest-dsl.html
==============================================================================
--- websites/production/camel/content/rest-dsl.html (original)
+++ websites/production/camel/content/rest-dsl.html Sun Aug 10 10:17:52 2014
@@ -249,7 +249,7 @@ public class UserPojo {
 <script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[restConfiguration().component(&quot;spark-rest&quot;).port(9091).componentProperty(&quot;foo&quot;,
&quot;123&quot;);]]></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">
 <script class="theme: Default; brush: java; gutter: false" type="syntaxhighlighter"><![CDATA[&lt;restConfiguration
component=&quot;spark-rest&quot; port=&quot;9091&quot;&gt; &lt;componentProperty
key=&quot;foo&quot; value=&quot;123&quot;/&gt; &lt;/restConfiguration&gt;]]></script>
-</div></div><p><span style="line-height: 1.4285715;"><br clear="none"></span></p><p>You
can configure properties on these levels.&#160;</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."&#160;</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></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><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&#160;<code>org.apache.camel.spi.RestConsumerFactory</code>.
The Rest DSL will then invoke the&#160;<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><p>&#160;</p><h3
id="RestDSL-SeeAlso">See Also</h3><p><a shape="rect" href="dsl.html">DSL</a></p><p><a
shape="rect" href="rest.html">Rest</a></p><p><a shape="rect" href="spark-rest.html">Spark-rest</a></p><p><a
shape="rect" href="how-do-i-import-rests-from-other-xml-files.html">How do I import rests
from other XML files</a></p></div>
+</div></div><p><span style="line-height: 1.4285715;"><br clear="none"></span></p><p>You
can configure properties on these levels.&#160;</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."&#160;</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></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><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&#160;<code>org.apache.camel.spi.RestConsumerFactory</code>.
The Rest DSL will then invoke the&#160;<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"
class="unresolved" href="#">Swagge</a>r&#160;by the&#160;<code>camel-swagger</code>
module. See more details at &#160;<a shape="rect" href="swagger.html">Swagger</a>&#160;and
the&#160;<code>camel-example-servlet-rest-tomcat</code> example from the Apache
Camel distribution.</p
 ><h3 id="RestDSL-SeeAlso">See Also</h3><p><a shape="rect" href="dsl.html">DSL</a></p><p><a
shape="rect" href="rest.html">Rest</a></p><p><a shape="rect" href="swagger.html">Swagger</a></p><p><a
shape="rect" href="spark-rest.html">Spark-rest</a></p><p><a shape="rect"
href="how-do-i-import-rests-from-other-xml-files.html">How do I import rests from other
XML files</a></p></div>
         </td>
         <td valign="top">
           <div class="navigation">

Added: websites/production/camel/content/swagger.html
==============================================================================
--- websites/production/camel/content/swagger.html (added)
+++ websites/production/camel/content/swagger.html Sun Aug 10 10:17:52 2014
@@ -0,0 +1,166 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!--
+
+    Licensed to the Apache Software Foundation (ASF) under one or more
+    contributor license agreements.  See the NOTICE file distributed with
+    this work for additional information regarding copyright ownership.
+    The ASF licenses this file to You under the Apache License, Version 2.0
+    (the "License"); you may not use this file except in compliance with
+    the License.  You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+-->
+<html>
+<head>
+    <link href="//camel.apache.org/styles/site.css" rel="stylesheet" type="text/css">
+    <link href="//camel.apache.org/styles/type-settings.css" rel="stylesheet" type="text/css">
+    <script src="//camel.apache.org/styles/prototype.js" type="text/javascript"></script>
+    <script src="//camel.apache.org/styles/rico.js" type="text/javascript"></script>
   
+    <script src="//camel.apache.org/styles/site.js" type="text/javascript"></script>
+
+    <meta http-equiv="Content-type" content="text/html;charset=UTF-8">
+
+    <style type="text/css">
+      .maincontent { overflow:hidden; }
+    </style>
+    <!--[if IE]>
+    <style type="text/css">
+      .maincontent { width:100%; }
+    </style>
+    <![endif]-->
+
+
+  <link href='//camel.apache.org/styles/highlighter/styles/shCoreCamel.css' rel='stylesheet'
type='text/css' />
+  <link href='//camel.apache.org/styles/highlighter/styles/shThemeCamel.css' rel='stylesheet'
type='text/css' />
+  <script src='//camel.apache.org/styles/highlighter/scripts/shCore.js' type='text/javascript'></script>
+  <script src='//camel.apache.org/styles/highlighter/scripts/shBrushJava.js' type='text/javascript'></script>
+  <script src='//camel.apache.org/styles/highlighter/scripts/shBrushXml.js' type='text/javascript'></script>
+  <script src='//camel.apache.org/styles/highlighter/scripts/shBrushPlain.js' type='text/javascript'></script>
+  
+  <script type="text/javascript">
+  SyntaxHighlighter.defaults['toolbar'] = false;
+  SyntaxHighlighter.all();
+  </script>
+
+    <title>
+    Apache Camel: Swagger
+    </title>
+</head>
+<body>
+<div class="white_box">
+<div class="header">
+  <div class="header_l">
+    <div class="header_r">
+    </div>
+  </div>
+</div>
+<div class="content">
+  <div class="content_l">
+    <div class="content_r">
+      <div>
+          <!-- Banner -->
+<div id="banner-content"><div id="asf_logo">
+	<div id="activemq_logo" style="height:108px; background:transparent url(banner.data/apache-camel-7.png)
no-repeat scroll left top;">
+            <a shape="rect" style="float:left; width:310px;display:block;text-indent:-5000px;text-decoration:none;line-height:140px;
margin-top:20px; margin-left:18px;" href="http://camel.apache.org/">Camel</a>
+            <a shape="rect" style="float:right; width:180px;display:block;text-indent:-5000px;text-decoration:none;line-height:80px;
margin-top:45px; margin-right:10px;" href="http://www.apache.org">Apache</a>
+	</div>
+</div></div>
+          <!-- Banner -->
+        <div class="top_red_bar">
+          <div id="site-breadcrumbs">
+                <!-- Breadcrumbs -->
+<a href="index.html">Apache Camel</a>&nbsp;&gt;&nbsp;<a href="documentation.html">Documentation</a>&nbsp;&gt;&nbsp;<a
href="components.html">Components</a>&nbsp;&gt;&nbsp;<a href="swagger.html">Swagger</a>
+          </div>
+          <!-- Quicklinks -->
+<div id="site-quicklinks"><p><a shape="rect" href="download.html">Download</a>
| <a shape="rect" href="javadoc.html">JavaDoc</a> | <a shape="rect" href="source.html">Source</a>
| <a shape="rect" href="discussion-forums.html">Forums</a> | <a shape="rect"
href="support.html">Support</a></p></div>
+          <!-- Quicklinks -->
+        </div>
+
+	<table border="0">
+	<tbody>
+        <tr>
+        <td valign="top" width="100%">
+<div class="wiki-content maincontent"><h2 id="Swagger-SwaggerComponent">Swagger
Component</h2><p><strong>Available as of Camel 2.14</strong></p><p>The
&#160;<a shape="rect" href="rest-dsl.html">Rest DSL</a>&#160;can be integrated
with the&#160;<code>camel-swagger</code> module which is used for exposing
the REST services and their APIs using <a shape="rect" class="external-link" href="http://swagger.wordnik.com/"
rel="nofollow">Swagger</a>.</p><p>Maven users will need to add the following
dependency to their&#160;<code>pom.xml</code>&#160;for this component:</p><div
class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent
pdl">
+<script class="theme: Default; brush: xml; gutter: false" type="syntaxhighlighter"><![CDATA[&lt;dependency&gt;
+    &lt;groupId&gt;org.apache.camel&lt;/groupId&gt;
+    &lt;artifactId&gt;camel-swagger&lt;/artifactId&gt;
+    &lt;version&gt;x.x.x&lt;/version&gt;
+    &lt;!-- use the same version as your Camel core version --&gt;
+&lt;/dependency&gt;
+]]></script>
+</div></div><h3 id="Swagger-Using">Using</h3><p>To use this
you need to configure the&#160;<code>org.apache.camel.component.swagger.RestSwaggerApiDeclarationServlet</code>&#160;in
the&#160;<code>WEB-INF/web.xml</code>&#160;file as shown below:</p><div
class="error"><span class="error">Error formatting macro: snippet: java.lang.IndexOutOfBoundsException:
Index: 20, Size: 20</span> </div><h3 id="Swagger-Options">Options</h3><p>The&#160;<code>org.apache.camel.component.swagger.RestSwaggerApiDeclarationServlet&#160;</code>supports
the following options which can be configured as context-param in the web.xml file.</p><div
class="confluenceTableSmall"><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th
colspan="1" rowspan="1" class="confluenceTh"><p>Option</p></th><th
colspan="1" rowspan="1" class="confluenceTh"><p>Type</p></th><th colspan="1"
rowspan="1" class="confluenceTh"><p>Description</p></th></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd">swagger.version
 </td><td colspan="1" rowspan="1" class="confluenceTd">String</td><td
colspan="1" rowspan="1" class="confluenceTd">Swagger spec version. Is default 1.2.</td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd">base.path<p>&#160;</p></td><td
colspan="1" rowspan="1" class="confluenceTd">String</td><td colspan="1" rowspan="1"
class="confluenceTd"><strong>Required</strong>: To setup the base path where
the API is available</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">api.version</td><td
colspan="1" rowspan="1" class="confluenceTd">String</td><td colspan="1" rowspan="1"
class="confluenceTd">The version of the api. Is default 0.0.0.</td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd">api.path</td><td colspan="1" rowspan="1"
class="confluenceTd">String</td><td colspan="1" rowspan="1" class="confluenceTd">Path
of the api</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">api.title</td><td
colspan="1" rowspan="1" class="confluenceTd">String</td><td c
 olspan="1" rowspan="1" class="confluenceTd"><strong>Required.</strong><span>&#160;The
title of the application.</span></td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd">api.description</td><td colspan="1" rowspan="1" class="confluenceTd">String</td><td
colspan="1" rowspan="1" class="confluenceTd"><strong>Required.</strong><span>&#160;A
short description of the application.</span></td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd">api.<span>termsOfServiceUrl</span></td><td
colspan="1" rowspan="1" class="confluenceTd">String</td><td colspan="1" rowspan="1"
class="confluenceTd"><span>A URL to the Terms of Service of the API.</span></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd">api.contact</td><td colspan="1" rowspan="1"
class="confluenceTd">String</td><td colspan="1" rowspan="1" class="confluenceTd"><span>An
email to be used for API-related correspondence.</span></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd">api.license</td><td col
 span="1" rowspan="1" class="confluenceTd">String</td><td colspan="1" rowspan="1"
class="confluenceTd"><span>The license name used for the API.</span></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd">api.licenseUrl</td><td colspan="1"
rowspan="1" class="confluenceTd">String</td><td colspan="1" rowspan="1" class="confluenceTd"><span>A
URL to the license used for the API.</span></td></tr></tbody></table></div></div><h3
id="Swagger-Examples">Examples</h3><p>TODO: rest example</p></div>
+        </td>
+        <td valign="top">
+          <div class="navigation">
+            <div class="navigation_top">
+                <!-- NavigationBar -->
+<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">
+    <input type="text" name="q" size="21">
+    <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&amp;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>
+        </td>
+        </tr>
+	</tbody>
+        </table>
+
+
+        <div class="bottom_red_bar"></div>
+      </div>
+    </div>
+  </div>
+</div>
+<div class="black_box">
+<div class="footer">
+  <div class="footer_l">
+    <div class="footer_r">
+      <div>
+        <a href="$base/privacy-policy.html">Privacy Policy</a> -
+        (<a href="https://cwiki.apache.org/confluence/pages/editpage.action?pageId=44993645">edit
page</a>)
+   	 (<a href="https://cwiki.apache.org/confluence/pages/viewpage.action?pageId=44993645&amp;showComments=true&amp;showCommentArea=true#addcomment">add
comment</a>)
+      </div>
+    </div>
+  </div>
+</div>
+</div>
+</div>
+<div class="design_attribution">
+&copy; 2004-2014 The Apache Software Foundation.
+<br>          
+Apache Camel, Camel, Apache, the Apache feather logo, and the Apache Camel project logo are
trademarks of The Apache Software Foundation.  All other marks mentioned may be trademarks
or registered trademarks of their respective owners.
+<br>
+<a href="http://hiramchirino.com">Graphic Design By Hiram</a>
+</div>
+
+<!-- Camel committers that would like access to the Analytics, send a note to private@camel.apache.org
-->
+<script type="text/javascript">
+
+  var _gaq = _gaq || [];
+  _gaq.push(['_setAccount', 'UA-25976253-1']);
+  _gaq.push(['_trackPageview']);
+
+  (function() {
+    var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+    ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+    var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+  })();
+
+</script>
+
+</body>
+</html>
+
+



Mime
View raw message