Repository: camel Updated Branches: refs/heads/master 261d02cab -> 2c78e2f30
http://git-wip-us.apache.org/repos/asf/camel/blob/2c78e2f3/examples/camel-example-swagger-xml/src/main/resources/camel-config-xml.xml ---------------------------------------------------------------------- diff --git a/examples/camel-example-swagger-xml/src/main/resources/camel-config-xml.xml b/examples/camel-example-swagger-xml/src/main/resources/camel-config-xml.xml new file mode 100755 index 0000000..45d4c0f --- /dev/null +++ b/examples/camel-example-swagger-xml/src/main/resources/camel-config-xml.xml @@ -0,0 +1,110 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!-- + 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. +--> + +<beans xmlns="http://www.springframework.org/schema/beans"; + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; + xmlns:camel="http://camel.apache.org/schema/spring"; + xsi:schemaLocation=" + http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd + http://camel.apache.org/schema/spring http://camel.apache.org/schema/spring/camel-spring.xsd";> + + <!-- a bean for user services --> + <bean id="userService" class="org.apache.camel.example.rest.UserService"/> + + <camelContext id="myCamel" xmlns="http://camel.apache.org/schema/spring";> + + <!-- configure rest to use the camel-servlet component, and use json binding mode --> + <!-- and tell to output json in pretty print mode --> + <!-- setup context path and port number that Apache Tomcat will deploy this application with, + as we use the servlet component, then we need to aid Camel to tell it these details so Camel + knows the url to the REST services. + Notice: This is optional, but needed if the RestRegistry should enlist accurate information. + You can access the RestRegistry from JMX at runtime --> + <!-- also enable swagger api, using the apiContextPath + and enable CORS so the swagger-ui web console can access the swagger api docs --> + <restConfiguration component="servlet" bindingMode="json" + contextPath="camel-example-swagger-xml/rest" port="8080" + apiContextPath="api-docs" apiContextListing="true" + enableCORS="true"> + + <!-- we want json output in pretty mode --> + <dataFormatProperty key="prettyPrint" value="true"/> + + <!-- setup swagger api descriptions --> + <apiProperty key="base.path" value="rest"/> + <apiProperty key="api.version" value="1.2.3"/> + <apiProperty key="api.title" value="User Services"/> + <apiProperty key="api.description" value="Camel Rest Example with Swagger that provides an User REST service"/> + <apiProperty key="api.contact.name" value="The Apache Camel team"/> + + </restConfiguration> + + <!-- defines the rest services using the context-path /user --> + <rest path="/user" consumes="application/json" produces="application/json"> + <description>User rest service</description> + + <!-- 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="integer"/> + <responseMessage message="The user that was found"/> + <responseMessage code="404" message="User not found"/> + <route> + <to uri="bean:userService?method=getUser(${header.id})"/> + <filter> + <simple>${body} == null</simple> + <setHeader headerName="Exchange.HTTP_RESPONSE_CODE"> + <constant>404</constant> + </setHeader> + </filter> + </route> + </get> + + <!-- 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> + + <!-- this is a rest GET to find all users --> + <get uri="/findAll" outType="org.apache.camel.example.rest.User[]"> + <description>Find all users</description> + <responseMessage message="All the users"/> + <to uri="bean:userService?method=listUsers"/> + </get> + </rest> + + <!-- defines the rest services using the context-path /echo --> + <rest path="/echo" consumes="application/text" produces="application/text"> + <description>Echo rest service</description> + + <get uri="/ping"> + <description>A ping service</description> + <route> + <transform> + <constant>pong</constant> + </transform> + </route> + </get> + + </rest> + + </camelContext> + +</beans> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/2c78e2f3/examples/camel-example-swagger-xml/src/main/resources/log4j.properties ---------------------------------------------------------------------- diff --git a/examples/camel-example-swagger-xml/src/main/resources/log4j.properties b/examples/camel-example-swagger-xml/src/main/resources/log4j.properties new file mode 100755 index 0000000..ed9a8f1 --- /dev/null +++ b/examples/camel-example-swagger-xml/src/main/resources/log4j.properties @@ -0,0 +1,30 @@ +## ------------------------------------------------------------------------ +## 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. +## ------------------------------------------------------------------------ + +# default properties to initialise log4j +log4j.rootLogger=INFO, console + +# settings for specific packages +#log4j.logger.com.wordnik.swagger=DEBUG +#log4j.logger.org.apache.camel.component.servlet=DEBUG +#log4j.logger.org.apache.camel.component.swagger=DEBUG +#log4j.logger.org.apache.camel=DEBUG + +# Console appender +log4j.appender.console=org.apache.log4j.ConsoleAppender +log4j.appender.console.layout=org.apache.log4j.PatternLayout +log4j.appender.console.layout.ConversionPattern=%d [%-15.15t] %-5p %-30.30c{1} - %m%n http://git-wip-us.apache.org/repos/asf/camel/blob/2c78e2f3/examples/camel-example-swagger-xml/src/main/webapp/META-INF/LICENSE.txt ---------------------------------------------------------------------- diff --git a/examples/camel-example-swagger-xml/src/main/webapp/META-INF/LICENSE.txt b/examples/camel-example-swagger-xml/src/main/webapp/META-INF/LICENSE.txt new file mode 100644 index 0000000..6b0b127 --- /dev/null +++ b/examples/camel-example-swagger-xml/src/main/webapp/META-INF/LICENSE.txt @@ -0,0 +1,203 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed 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. + http://git-wip-us.apache.org/repos/asf/camel/blob/2c78e2f3/examples/camel-example-swagger-xml/src/main/webapp/META-INF/NOTICE.txt ---------------------------------------------------------------------- diff --git a/examples/camel-example-swagger-xml/src/main/webapp/META-INF/NOTICE.txt b/examples/camel-example-swagger-xml/src/main/webapp/META-INF/NOTICE.txt new file mode 100644 index 0000000..2e215bf --- /dev/null +++ b/examples/camel-example-swagger-xml/src/main/webapp/META-INF/NOTICE.txt @@ -0,0 +1,11 @@ + ========================================================================= + == NOTICE file corresponding to the section 4 d of == + == the Apache License, Version 2.0, == + == in this case for the Apache Camel distribution. == + ========================================================================= + + This product includes software developed by + The Apache Software Foundation (http://www.apache.org/). + + Please read the different LICENSE files present in the licenses directory of + this distribution. http://git-wip-us.apache.org/repos/asf/camel/blob/2c78e2f3/examples/camel-example-swagger-xml/src/main/webapp/WEB-INF/web.xml ---------------------------------------------------------------------- diff --git a/examples/camel-example-swagger-xml/src/main/webapp/WEB-INF/web.xml b/examples/camel-example-swagger-xml/src/main/webapp/WEB-INF/web.xml new file mode 100755 index 0000000..8ec650c --- /dev/null +++ b/examples/camel-example-swagger-xml/src/main/webapp/WEB-INF/web.xml @@ -0,0 +1,54 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<!-- + 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. +--> + +<web-app version="2.5" xmlns="http://java.sun.com/xml/ns/javaee"; + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; + xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd";> + + <display-name>My Camel Rest Application</display-name> + + <!-- location of Camel Spring xml files --> + <context-param> + <param-name>contextConfigLocation</param-name> + <param-value>classpath:camel-config-xml.xml</param-value> + </context-param> + + <!-- the listener that kick-starts Spring --> + <listener> + <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class> + </listener> + + <!-- to setup Camel Servlet --> + <servlet> + <display-name>Camel Http Transport Servlet</display-name> + <servlet-name>CamelServlet</servlet-name> + <servlet-class>org.apache.camel.component.servlet.CamelHttpTransportServlet</servlet-class> + <load-on-startup>1</load-on-startup> + </servlet> + + <!-- define that url path for the Camel Servlet to use --> + <servlet-mapping> + <servlet-name>CamelServlet</servlet-name> + <url-pattern>/rest/*</url-pattern> + </servlet-mapping> + + <welcome-file-list> + <welcome-file>home.html</welcome-file> + </welcome-file-list> + +</web-app> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/2c78e2f3/examples/camel-example-swagger-xml/src/main/webapp/home.html ---------------------------------------------------------------------- diff --git a/examples/camel-example-swagger-xml/src/main/webapp/home.html b/examples/camel-example-swagger-xml/src/main/webapp/home.html new file mode 100644 index 0000000..bc44836 --- /dev/null +++ b/examples/camel-example-swagger-xml/src/main/webapp/home.html @@ -0,0 +1,100 @@ +<!-- + 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> + <meta charset="utf-8"/> + <meta name="viewport" content="width=device-width, initial-scale=1.0"/> + <title>Apache Camel Swagger Example</title> + <link rel="stylesheet" href="css/foundation.min.css"/> + <script src="js/vendor/modernizr.js"></script> +</head> + +<body> +<div class="row"> + <div class="large-12 columns"> + <h2>Apache Camel Example using Swagger</h2> + </div> +</div> + +<div class="row"> + <div class="large-12 columns"> + This example shows how to use Servlet REST to define REST endpoints in Camel routes using the Rest DSL in XML, + and using camel-swagger-java to expose the REST service APIs. + + <br/> + + This example is implemented in XML DSL. + + <br/> + The XML DSL the routes are define in XML code, in the <tt>src/main/resources/camel-config-xml.xml</tt> file. + + <p/> + There is a <i>user</i> REST service that supports the following operations + <ul> + <li>GET /user/{id} - to view a user with the given id</li> + <li>GET /user/final - to view all users</li> + <li>PUT /user - to update/create an user</li> + </ul> + + The view operations are HTTP GET, and update is using HTTP PUT. + + From a web browser you can access the first two services using the following links + + <ul> + <li><a href="rest/user/123">user/123</a> - to view the user with id 123</li> + <li><a href="rest/user/findAll">user/findAll</a> - to list all users</li> + </ul> + + From the command shell you can use curl to access the service as shown below: +<pre> + curl -X GET -H "Accept: application/json" http://localhost:8080/camel-example-swagger-xml/rest/user/123 + curl -X GET -H "Accept: application/json" http://localhost:8080/camel-example-swagger-xml/rest/user/findAll + curl -X PUT -d "{ \"id\": 666, \"name\": \"The devil\"}" -H "Accept: application/json" http://localhost:8080/camel-example-swagger-xml/rest/user +</pre> + + Notice when trying to get user with id 789 then there is a built-in delay of 0.5-2 seconds, to simulate some + slowness in the service. + + <p/> + This example offers an API browser using Swagger which is accessible from the following link + <ul> + <li><a href="rest/api-docs">api-docs</a> - list all CamelContexts in the JVM that may have REST services</li> + <li><a href="rest/api-docs/myCamel">api-docs/myCamel</a> - myCamel - overview of the apis from the REST services</li> + <li><a href="rest/api-docs/myCamel/user">api-docs/myCamel/user</a> - myCamel - api of the user REST service</li> + </ul> + + <p/> + To use the swagger ui, follow this link. Replace the URL value with this one to access the REST local resources http://localhost:8080/camel-example-swagger-xml/rest/api-docs/myCamel + <ul> + <li><a href="index.html">swagger</a> - swagger ui page</li> + </ul> + + <p/> + If you hit any problems please let us know on the + <a href="http://camel.apache.org/discussion-forums.html";>Camel Forums</a> + <br/> + <br/> + Please help us make Apache Camel better - we appreciate any feedback you may + have. Enjoy! + <br/> + <br/> + The Camel riders! + </div> +</div> +</body> + +</html> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/camel/blob/2c78e2f3/examples/pom.xml ---------------------------------------------------------------------- diff --git a/examples/pom.xml b/examples/pom.xml index 16df3fc..00dd95d 100644 --- a/examples/pom.xml +++ b/examples/pom.xml @@ -86,7 +86,7 @@ <module>camel-example-sql</module> <module>camel-example-sql-blueprint</module> <module>camel-example-swagger-cdi</module> - <module>camel-example-swagger-java</module> + <module>camel-example-swagger-xml</module> <module>camel-example-tracer</module> <module>camel-example-twitter-websocket</module> <module>camel-example-twitter-websocket-blueprint</module>
