You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by da...@apache.org on 2015/09/17 17:15:40 UTC
[1/8] camel git commit: CAMEL-7800: camel-swagger-java - work in
progress
Repository: camel
Updated Branches:
refs/heads/swagger [created] 03c407c94
CAMEL-7800: camel-swagger-java - work in progress
Project: http://git-wip-us.apache.org/repos/asf/camel/repo
Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/d40c0091
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/d40c0091
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/d40c0091
Branch: refs/heads/swagger
Commit: d40c00911ee70399d8ad494db89a14045a7e27a7
Parents: 0807773
Author: Claus Ibsen <da...@apache.org>
Authored: Thu Sep 17 13:52:53 2015 +0200
Committer: Claus Ibsen <da...@apache.org>
Committed: Thu Sep 17 13:52:53 2015 +0200
----------------------------------------------------------------------
components/camel-swagger-java/pom.xml | 101 +++++++++
.../swagger/DefaultCamelSwaggerServlet.java | 86 ++++++++
.../RestSwaggerApiDeclarationServlet.java | 198 ++++++++++++++++++
.../src/main/resources/META-INF/LICENSE.txt | 203 +++++++++++++++++++
.../src/main/resources/META-INF/NOTICE.txt | 11 +
.../src/test/resources/log4j.properties | 42 ++++
components/pom.xml | 1 +
parent/pom.xml | 1 +
8 files changed, 643 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/d40c0091/components/camel-swagger-java/pom.xml
----------------------------------------------------------------------
diff --git a/components/camel-swagger-java/pom.xml b/components/camel-swagger-java/pom.xml
new file mode 100644
index 0000000..d7aa2e4
--- /dev/null
+++ b/components/camel-swagger-java/pom.xml
@@ -0,0 +1,101 @@
+<?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.
+-->
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+ <modelVersion>4.0.0</modelVersion>
+
+ <parent>
+ <groupId>org.apache.camel</groupId>
+ <artifactId>components</artifactId>
+ <version>2.16-SNAPSHOT</version>
+ </parent>
+
+ <artifactId>camel-swagger-java</artifactId>
+ <packaging>bundle</packaging>
+ <name>Camel :: Swagger Java</name>
+ <description>Camel Swagger Java support</description>
+
+ <properties>
+ <camel.osgi.export.pkg>org.apache.camel.component.swagger.*</camel.osgi.export.pkg>
+ </properties>
+
+ <dependencies>
+
+ <dependency>
+ <groupId>org.apache.camel</groupId>
+ <artifactId>camel-core</artifactId>
+ </dependency>
+
+ <dependency>
+ <groupId>io.swagger</groupId>
+ <artifactId>swagger-core</artifactId>
+ <version>${swagger-java-version}</version>
+ </dependency>
+
+ <dependency>
+ <groupId>io.swagger</groupId>
+ <artifactId>swagger-annotations</artifactId>
+ <version>${swagger-java-version}</version>
+ </dependency>
+
+ <dependency>
+ <groupId>io.swagger</groupId>
+ <artifactId>swagger-jaxrs</artifactId>
+ <version>${swagger-java-version}</version>
+ </dependency>
+
+ <dependency>
+ <groupId>javax.servlet</groupId>
+ <artifactId>servlet-api</artifactId>
+ <version>2.5</version>
+ <scope>provided</scope>
+ </dependency>
+
+ <!-- testing -->
+ <dependency>
+ <groupId>org.apache.camel</groupId>
+ <artifactId>camel-test</artifactId>
+ <scope>test</scope>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.camel</groupId>
+ <artifactId>camel-jetty8</artifactId>
+ <scope>test</scope>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.camel</groupId>
+ <artifactId>camel-http-common</artifactId>
+ <scope>test</scope>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.camel</groupId>
+ <artifactId>camel-jetty-common</artifactId>
+ <scope>test</scope>
+ </dependency>
+ <dependency>
+ <groupId>junit</groupId>
+ <artifactId>junit</artifactId>
+ <scope>test</scope>
+ </dependency>
+ <dependency>
+ <groupId>org.slf4j</groupId>
+ <artifactId>slf4j-log4j12</artifactId>
+ <scope>test</scope>
+ </dependency>
+ </dependencies>
+
+</project>
http://git-wip-us.apache.org/repos/asf/camel/blob/d40c0091/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/DefaultCamelSwaggerServlet.java
----------------------------------------------------------------------
diff --git a/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/DefaultCamelSwaggerServlet.java b/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/DefaultCamelSwaggerServlet.java
new file mode 100644
index 0000000..12d79aa
--- /dev/null
+++ b/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/DefaultCamelSwaggerServlet.java
@@ -0,0 +1,86 @@
+/**
+ * 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.
+ */
+package org.apache.camel.swagger;
+
+import java.lang.management.ManagementFactory;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Set;
+import javax.management.MBeanServer;
+import javax.management.ObjectName;
+
+import org.apache.camel.model.ModelHelper;
+import org.apache.camel.model.rest.RestDefinition;
+import org.apache.camel.model.rest.RestsDefinition;
+import org.apache.camel.util.CamelVersionHelper;
+
+public class DefaultCamelSwaggerServlet extends RestSwaggerApiDeclarationServlet {
+
+ @Override
+ public List<RestDefinition> getRestDefinitions(String camelId) throws Exception {
+ ObjectName found = null;
+
+ MBeanServer server = ManagementFactory.getPlatformMBeanServer();
+ Set<ObjectName> names = server.queryNames(new ObjectName("org.apache.camel:type=context,*"), null);
+ for (ObjectName on : names) {
+ String id = on.getKeyProperty("name");
+ if (id.startsWith("\"") && id.endsWith("\"")) {
+ id = id.substring(1, id.length() - 1);
+ }
+ if (camelId == null || camelId.equals(id)) {
+ // filter out older Camel versions as this requires Camel 2.15 or better
+ String version = (String) server.getAttribute(on, "CamelVersion");
+ if (CamelVersionHelper.isGE("2.15.0", version)) {
+ found = on;
+ }
+ }
+ }
+
+ if (found != null) {
+ String xml = (String) server.invoke(found, "dumpRestsAsXml", null, null);
+ if (xml != null) {
+ RestsDefinition rests = ModelHelper.createModelFromXml(null, xml, RestsDefinition.class);
+ if (rests != null) {
+ return rests.getRests();
+ }
+ }
+ }
+
+ return null;
+ }
+
+ @Override
+ public List<String> findCamelContexts() throws Exception {
+ List<String> answer = new ArrayList<>();
+
+ MBeanServer server = ManagementFactory.getPlatformMBeanServer();
+ Set<ObjectName> names = server.queryNames(new ObjectName("*:type=context,*"), null);
+ for (ObjectName on : names) {
+ String id = on.getKeyProperty("name");
+ if (id.startsWith("\"") && id.endsWith("\"")) {
+ id = id.substring(1, id.length() - 1);
+ }
+
+ // filter out older Camel versions as this requires Camel 2.15 or better
+ String version = (String) server.getAttribute(on, "CamelVersion");
+ if (CamelVersionHelper.isGE("2.15.0", version)) {
+ answer.add(id);
+ }
+ }
+ return answer;
+ }
+}
http://git-wip-us.apache.org/repos/asf/camel/blob/d40c0091/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/RestSwaggerApiDeclarationServlet.java
----------------------------------------------------------------------
diff --git a/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/RestSwaggerApiDeclarationServlet.java b/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/RestSwaggerApiDeclarationServlet.java
new file mode 100644
index 0000000..c88b261
--- /dev/null
+++ b/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/RestSwaggerApiDeclarationServlet.java
@@ -0,0 +1,198 @@
+/**
+ * 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.
+ */
+package org.apache.camel.swagger;
+
+import java.io.IOException;
+import java.net.MalformedURLException;
+import java.net.URL;
+import java.util.List;
+import javax.servlet.ServletConfig;
+import javax.servlet.ServletException;
+import javax.servlet.http.HttpServlet;
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
+
+import io.swagger.jaxrs.config.BeanConfig;
+import org.apache.camel.model.rest.RestDefinition;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+public abstract class RestSwaggerApiDeclarationServlet extends HttpServlet {
+
+ private Logger LOG = LoggerFactory.getLogger(RestSwaggerApiDeclarationServlet.class);
+
+ // TODO: implement me
+ //private RestSwaggerReader reader = new RestSwaggerReader();
+ private BeanConfig swaggerConfig = new BeanConfig();
+ private boolean cors;
+ private volatile boolean initDone;
+
+ @Override
+ public void init(ServletConfig config) throws ServletException {
+ super.init(config);
+
+ // configure swagger options
+ String s = config.getInitParameter("swagger.version");
+ if (s != null) {
+ swaggerConfig.setVersion(s);
+ }
+ s = config.getInitParameter("base.path");
+ if (s != null) {
+ swaggerConfig.setBasePath(s);
+ }
+ s = config.getInitParameter("cors");
+ if (s != null) {
+ cors = "true".equalsIgnoreCase(s);
+ }
+
+ String title = config.getInitParameter("api.title");
+ String description = config.getInitParameter("api.description");
+ String termsOfServiceUrl = config.getInitParameter("api.termsOfServiceUrl");
+ String contact = config.getInitParameter("api.contact");
+ String license = config.getInitParameter("api.license");
+ String licenseUrl = config.getInitParameter("api.licenseUrl");
+
+ swaggerConfig.setTitle(title);
+ swaggerConfig.setDescription(description);
+ swaggerConfig.setTermsOfServiceUrl(termsOfServiceUrl);
+ swaggerConfig.setContact(contact);
+ swaggerConfig.setLicense(license);
+ swaggerConfig.setLicenseUrl(licenseUrl);
+ }
+
+ public abstract List<RestDefinition> getRestDefinitions(String camelId) throws Exception;
+
+ public abstract List<String> findCamelContexts() throws Exception;
+
+ @Override
+ protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
+
+ if (!initDone) {
+ initBaseAndApiPaths(request);
+ }
+
+ String contextId;
+ String route = request.getPathInfo();
+
+ try {
+
+ // render list of camel contexts as root
+ if (route == null || route.equals("") || route.equals("/")) {
+ renderCamelContexts(request, response);
+ } else {
+ // first part is the camel context
+ if (route.startsWith("/")) {
+ route = route.substring(1);
+ }
+ // the remainder is the route part
+ contextId = route.split("/")[0];
+ if (route.startsWith(contextId)) {
+ route = route.substring(contextId.length());
+ }
+
+
+ // TODO: implement these
+ if (!route.equals("") && !route.equals("/")) {
+ // render overview if the route is empty or is the root path
+ // renderApiDeclaration(request, response, contextId, route);
+ } else {
+ // renderResourceListing(request, response, contextId);
+ }
+ }
+ } catch (Exception e) {
+ LOG.warn("Error rendering swagger due " + e.getMessage());
+ }
+ }
+
+ private void initBaseAndApiPaths(HttpServletRequest request) throws MalformedURLException {
+ String base = swaggerConfig.getBasePath();
+ if (base == null || !base.startsWith("http")) {
+ // base path is configured using relative, so lets calculate the absolute url now we have the http request
+ URL url = new URL(request.getRequestURL().toString());
+ if (base == null) {
+ base = "";
+ }
+ String path = translateContextPath(request);
+ if (url.getPort() != 80 && url.getPort() != -1) {
+ base = url.getProtocol() + "://" + url.getHost() + ":" + url.getPort() + path + "/" + base;
+ } else {
+ base = url.getProtocol() + "://" + url.getHost() + request.getContextPath() + "/" + base;
+ }
+ swaggerConfig.setBasePath(base);
+ }
+
+ // TODO: api path?
+ /*
+ base = swaggerConfig.getApiPath
+ if (base == null || !base.startsWith("http")) {
+ // api path is configured using relative, so lets calculate the absolute url now we have the http request
+ val url = new URL(request.getRequestURL.toString)
+ if (base == null) {
+ base = ""
+ }
+ val path = translateContextPath(request)
+ if (url.getPort != 80 && url.getPort != -1) {
+ base = url.getProtocol + "://" + url.getHost + ":" + url.getPort + path + "/" + base
+ } else {
+ base = url.getProtocol + "://" + url.getHost + request.getContextPath + "/" + base
+ }
+ swaggerConfig.setApiPath(base)
+ } */
+ initDone = true;
+ }
+
+ /**
+ * We do only want the base context-path and not sub paths
+ */
+ private String translateContextPath(HttpServletRequest request) {
+ String path = request.getContextPath();
+ if (path.isEmpty() || path.equals("/")) {
+ return "";
+ } else {
+ int idx = path.lastIndexOf("/");
+ if (idx > 0) {
+ return path.substring(0, idx);
+ }
+ }
+ return path;
+ }
+
+ /**
+ * Renders a list of available CamelContexts in the JVM
+ */
+ private void renderCamelContexts(HttpServletRequest request, HttpServletResponse response) throws Exception {
+ LOG.trace("renderCamelContexts");
+
+ if (cors) {
+ response.addHeader("Access-Control-Allow-Headers", "Origin, Accept, X-Requested-With, Content-Type, Access-Control-Request-Method, Access-Control-Request-Headers");
+ response.addHeader("Access-Control-Allow-Methods", "GET, HEAD, POST, PUT, DELETE, TRACE, OPTIONS, CONNECT, PATCH");
+ response.addHeader("Access-Control-Allow-Origin", "*");
+ }
+
+ List<String> contexts = findCamelContexts();
+ response.getWriter().print("[\n");
+ for (int i = 0; i < contexts.size(); i++) {
+ String name = contexts.get(i);
+ response.getWriter().print("{\"name\": \"" + name + "\"}");
+ if (i < contexts.size() - 1) {
+ response.getWriter().print(",\n");
+ }
+ }
+ response.getWriter().print("\n]");
+ }
+
+}
http://git-wip-us.apache.org/repos/asf/camel/blob/d40c0091/components/camel-swagger-java/src/main/resources/META-INF/LICENSE.txt
----------------------------------------------------------------------
diff --git a/components/camel-swagger-java/src/main/resources/META-INF/LICENSE.txt b/components/camel-swagger-java/src/main/resources/META-INF/LICENSE.txt
new file mode 100644
index 0000000..6b0b127
--- /dev/null
+++ b/components/camel-swagger-java/src/main/resources/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/d40c0091/components/camel-swagger-java/src/main/resources/META-INF/NOTICE.txt
----------------------------------------------------------------------
diff --git a/components/camel-swagger-java/src/main/resources/META-INF/NOTICE.txt b/components/camel-swagger-java/src/main/resources/META-INF/NOTICE.txt
new file mode 100644
index 0000000..2e215bf
--- /dev/null
+++ b/components/camel-swagger-java/src/main/resources/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/d40c0091/components/camel-swagger-java/src/test/resources/log4j.properties
----------------------------------------------------------------------
diff --git a/components/camel-swagger-java/src/test/resources/log4j.properties b/components/camel-swagger-java/src/test/resources/log4j.properties
new file mode 100644
index 0000000..3e0349e
--- /dev/null
+++ b/components/camel-swagger-java/src/test/resources/log4j.properties
@@ -0,0 +1,42 @@
+## ------------------------------------------------------------------------
+## 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.
+## ------------------------------------------------------------------------
+
+#
+# The logging properties used for testing.
+#
+log4j.rootLogger=INFO, file
+
+# uncomment the following to enable camel debugging
+#log4j.logger.org.apache.camel.component.swagger=TRACE
+#log4j.logger.com.wordnik.swagger=DEBUG
+
+# CONSOLE appender not used by default
+log4j.appender.out=org.apache.log4j.ConsoleAppender
+log4j.appender.out.layout=org.apache.log4j.PatternLayout
+log4j.appender.out.layout.ConversionPattern=%d [%-15.15t] %-5p %-30.30c{1} - %m%n
+# MDC
+#log4j.appender.out.layout.ConversionPattern=%d [%-15.15t] %-5p %-30.30c{1} - %-10.10X{camel.breadcrumbId} - %-10.10X{camelexchangeId} - %-10.10X{camel.correlationId} - %-10.10X{camel.routeId} - %m%n
+
+# File appender
+log4j.appender.file=org.apache.log4j.FileAppender
+log4j.appender.file.layout=org.apache.log4j.PatternLayout
+log4j.appender.file.file=target/camel-swagger-java-test.log
+log4j.appender.file.append=true
+log4j.appender.file.layout.ConversionPattern=%d [%-15.15t] %-5p %-30.30c{1} - %m%n
+# MDC
+#log4j.appender.file.layout.ConversionPattern=%d [%-15.15t] %-5p %-30.30c{1} - %-10.10X{camel.breadcrumbId} - %-10.10X{camel.exchangeId} - %-10.10X{camel.correlationId} - %-10.10X{camel.routeId} - %m%n
+
http://git-wip-us.apache.org/repos/asf/camel/blob/d40c0091/components/pom.xml
----------------------------------------------------------------------
diff --git a/components/pom.xml b/components/pom.xml
index 0725607..cc308fb 100644
--- a/components/pom.xml
+++ b/components/pom.xml
@@ -224,6 +224,7 @@
<module>camel-stringtemplate</module>
<module>camel-syslog</module>
<module>camel-swagger</module>
+ <module>camel-swagger-java</module>
<module>camel-tagsoup</module>
<module>camel-tarfile</module>
<module>camel-twitter</module>
http://git-wip-us.apache.org/repos/asf/camel/blob/d40c0091/parent/pom.xml
----------------------------------------------------------------------
diff --git a/parent/pom.xml b/parent/pom.xml
index f48d42b..f594bba 100644
--- a/parent/pom.xml
+++ b/parent/pom.xml
@@ -482,6 +482,7 @@
<swagger-version>1.3.12</swagger-version>
<swagger-guava-version>15.0</swagger-guava-version>
<swagger-bundle-version>1.3.12_1</swagger-bundle-version>
+ <swagger-java-version>1.5.3</swagger-java-version>
<stax-api-version>1.0.1</stax-api-version>
<stax2-api-bundle-version>3.1.4</stax2-api-bundle-version>
<stringtemplate-bundle-version>4.0.8_1</stringtemplate-bundle-version>
[4/8] camel git commit: CAMEL-7800: camel-swagger-java - work in
progress
Posted by da...@apache.org.
CAMEL-7800: camel-swagger-java - work in progress
Project: http://git-wip-us.apache.org/repos/asf/camel/repo
Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/4741cecc
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/4741cecc
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/4741cecc
Branch: refs/heads/swagger
Commit: 4741cecc64b6f150b25d82ee096368e4fa0cee83
Parents: 5925c04
Author: Claus Ibsen <da...@apache.org>
Authored: Thu Sep 17 16:05:22 2015 +0200
Committer: Claus Ibsen <da...@apache.org>
Committed: Thu Sep 17 16:28:55 2015 +0200
----------------------------------------------------------------------
components/camel-swagger-java/pom.xml | 2 +-
.../RestSwaggerApiDeclarationServlet.java | 66 +++++++++++++-------
.../apache/camel/swagger/RestSwaggerReader.java | 11 ++++
.../camel/swagger/RestSwaggerReaderTest.java | 5 +-
4 files changed, 57 insertions(+), 27 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/4741cecc/components/camel-swagger-java/pom.xml
----------------------------------------------------------------------
diff --git a/components/camel-swagger-java/pom.xml b/components/camel-swagger-java/pom.xml
index d7aa2e4..5e0177a 100644
--- a/components/camel-swagger-java/pom.xml
+++ b/components/camel-swagger-java/pom.xml
@@ -30,7 +30,7 @@
<description>Camel Swagger Java support</description>
<properties>
- <camel.osgi.export.pkg>org.apache.camel.component.swagger.*</camel.osgi.export.pkg>
+ <camel.osgi.export.pkg>org.apache.camel.swagger.*</camel.osgi.export.pkg>
</properties>
<dependencies>
http://git-wip-us.apache.org/repos/asf/camel/blob/4741cecc/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/RestSwaggerApiDeclarationServlet.java
----------------------------------------------------------------------
diff --git a/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/RestSwaggerApiDeclarationServlet.java b/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/RestSwaggerApiDeclarationServlet.java
index c88b261..9a918b2 100644
--- a/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/RestSwaggerApiDeclarationServlet.java
+++ b/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/RestSwaggerApiDeclarationServlet.java
@@ -26,7 +26,11 @@ import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.SerializationFeature;
import io.swagger.jaxrs.config.BeanConfig;
+import io.swagger.models.Swagger;
import org.apache.camel.model.rest.RestDefinition;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
@@ -35,8 +39,7 @@ public abstract class RestSwaggerApiDeclarationServlet extends HttpServlet {
private Logger LOG = LoggerFactory.getLogger(RestSwaggerApiDeclarationServlet.class);
- // TODO: implement me
- //private RestSwaggerReader reader = new RestSwaggerReader();
+ private RestSwaggerReader reader = new RestSwaggerReader();
private BeanConfig swaggerConfig = new BeanConfig();
private boolean cors;
private volatile boolean initDone;
@@ -54,6 +57,10 @@ public abstract class RestSwaggerApiDeclarationServlet extends HttpServlet {
if (s != null) {
swaggerConfig.setBasePath(s);
}
+ s = config.getInitParameter("host");
+ if (s != null) {
+ swaggerConfig.setHost(s);
+ }
s = config.getInitParameter("cors");
if (s != null) {
cors = "true".equalsIgnoreCase(s);
@@ -110,7 +117,7 @@ public abstract class RestSwaggerApiDeclarationServlet extends HttpServlet {
// render overview if the route is empty or is the root path
// renderApiDeclaration(request, response, contextId, route);
} else {
- // renderResourceListing(request, response, contextId);
+ renderResourceListing(request, response, contextId);
}
}
} catch (Exception e) {
@@ -118,6 +125,33 @@ public abstract class RestSwaggerApiDeclarationServlet extends HttpServlet {
}
}
+ private void renderResourceListing(HttpServletRequest request, HttpServletResponse response, String contextId) throws Exception {
+ LOG.trace("renderResourceListing");
+
+ if (cors) {
+ response.addHeader("Access-Control-Allow-Headers", "Origin, Accept, X-Requested-With, Content-Type, Access-Control-Request-Method, Access-Control-Request-Headers");
+ response.addHeader("Access-Control-Allow-Methods", "GET, HEAD, POST, PUT, DELETE, TRACE, OPTIONS, CONNECT, PATCH");
+ response.addHeader("Access-Control-Allow-Origin", "*");
+ }
+
+ List<RestDefinition> rests = getRestDefinitions(contextId);
+ if (rests != null) {
+
+ // TODO: combine the rests
+
+ for (RestDefinition rest : rests) {
+ Swagger swagger = reader.read(rest, swaggerConfig);
+
+ ObjectMapper mapper = new ObjectMapper();
+ mapper.enable(SerializationFeature.INDENT_OUTPUT);
+ mapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);
+ mapper.writeValue(response.getOutputStream(), swagger);
+ }
+ } else {
+ response.setStatus(204);
+ }
+ }
+
private void initBaseAndApiPaths(HttpServletRequest request) throws MalformedURLException {
String base = swaggerConfig.getBasePath();
if (base == null || !base.startsWith("http")) {
@@ -127,31 +161,15 @@ public abstract class RestSwaggerApiDeclarationServlet extends HttpServlet {
base = "";
}
String path = translateContextPath(request);
+ swaggerConfig.setHost(url.getHost());
+
if (url.getPort() != 80 && url.getPort() != -1) {
- base = url.getProtocol() + "://" + url.getHost() + ":" + url.getPort() + path + "/" + base;
+ swaggerConfig.setHost(url.getHost() + ":" + url.getPort());
} else {
- base = url.getProtocol() + "://" + url.getHost() + request.getContextPath() + "/" + base;
+ swaggerConfig.setHost(url.getHost());
}
- swaggerConfig.setBasePath(base);
+ swaggerConfig.setBasePath(path + "/" + base);
}
-
- // TODO: api path?
- /*
- base = swaggerConfig.getApiPath
- if (base == null || !base.startsWith("http")) {
- // api path is configured using relative, so lets calculate the absolute url now we have the http request
- val url = new URL(request.getRequestURL.toString)
- if (base == null) {
- base = ""
- }
- val path = translateContextPath(request)
- if (url.getPort != 80 && url.getPort != -1) {
- base = url.getProtocol + "://" + url.getHost + ":" + url.getPort + path + "/" + base
- } else {
- base = url.getProtocol + "://" + url.getHost + request.getContextPath + "/" + base
- }
- swaggerConfig.setApiPath(base)
- } */
initDone = true;
}
http://git-wip-us.apache.org/repos/asf/camel/blob/4741cecc/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/RestSwaggerReader.java
----------------------------------------------------------------------
diff --git a/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/RestSwaggerReader.java b/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/RestSwaggerReader.java
index de2de46..662cb34 100644
--- a/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/RestSwaggerReader.java
+++ b/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/RestSwaggerReader.java
@@ -25,6 +25,7 @@ import java.util.Locale;
import io.swagger.jaxrs.config.BeanConfig;
import io.swagger.models.Operation;
import io.swagger.models.Path;
+import io.swagger.models.Response;
import io.swagger.models.Swagger;
import io.swagger.models.parameters.BodyParameter;
import io.swagger.models.parameters.FormParameter;
@@ -34,6 +35,7 @@ import io.swagger.models.parameters.PathParameter;
import io.swagger.models.parameters.QueryParameter;
import org.apache.camel.model.rest.RestDefinition;
import org.apache.camel.model.rest.RestOperationParamDefinition;
+import org.apache.camel.model.rest.RestOperationResponseMsgDefinition;
import org.apache.camel.model.rest.RestParamType;
import org.apache.camel.model.rest.VerbDefinition;
@@ -70,9 +72,13 @@ public class RestSwaggerReader {
if (verb.getConsumes() != null) {
op.consumes(verb.getConsumes());
+ } else if (rest.getConsumes() != null) {
+ op.consumes(rest.getConsumes());
}
if (verb.getProduces() != null) {
op.produces(verb.getProduces());
+ } else if (rest.getProduces() != null) {
+ op.produces(rest.getProduces());
}
if (verb.getDescriptionText() != null) {
op.summary(verb.getDescriptionText());
@@ -99,6 +105,11 @@ public class RestSwaggerReader {
op.addParameter(parameter);
}
}
+ for (RestOperationResponseMsgDefinition msg : verb.getResponseMsgs()) {
+ Response response = new Response();
+ response.setDescription(msg.getMessage());
+ op.addResponse("" + msg.getCode(), response);
+ }
// add path
swagger.path(opPath, path);
http://git-wip-us.apache.org/repos/asf/camel/blob/4741cecc/components/camel-swagger-java/src/test/java/org/apache/camel/swagger/RestSwaggerReaderTest.java
----------------------------------------------------------------------
diff --git a/components/camel-swagger-java/src/test/java/org/apache/camel/swagger/RestSwaggerReaderTest.java b/components/camel-swagger-java/src/test/java/org/apache/camel/swagger/RestSwaggerReaderTest.java
index 6ee65ea..45aa629 100644
--- a/components/camel-swagger-java/src/test/java/org/apache/camel/swagger/RestSwaggerReaderTest.java
+++ b/components/camel-swagger-java/src/test/java/org/apache/camel/swagger/RestSwaggerReaderTest.java
@@ -42,14 +42,15 @@ public class RestSwaggerReaderTest extends CamelTestSupport {
return new RouteBuilder() {
@Override
public void configure() throws Exception {
- rest("/hello")
+ rest("/hello").consumes("application/json").produces("application/json")
.get("/hi/{name}").description("Saying hi")
.param().name("name").type(RestParamType.path).dataType("string").description("Who is it").endParam()
.to("log:hi")
.get("/bye/{name}").description("Saying bye")
.param().name("name").type(RestParamType.path).dataType("string").description("Who is it").endParam()
+ .responseMessage().code(200).message("A reply message").endResponseMessage()
.to("log:bye")
- .post("/bye").description("To update the greeting message")
+ .post("/bye").description("To update the greeting message").consumes("application/xml").produces("application/xml")
.param().name("greeting").type(RestParamType.body).dataType("string").description("Message to use as greeting").endParam()
.to("log:bye");
}
[6/8] camel git commit: CAMEL-7800: camel-swagger-java example
Posted by da...@apache.org.
CAMEL-7800: camel-swagger-java example
Project: http://git-wip-us.apache.org/repos/asf/camel/repo
Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/928a76e8
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/928a76e8
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/928a76e8
Branch: refs/heads/swagger
Commit: 928a76e80c934a8979ed11cd0ec4dd7831623ee2
Parents: 168bfe5
Author: Claus Ibsen <da...@apache.org>
Authored: Thu Sep 17 16:36:34 2015 +0200
Committer: Claus Ibsen <da...@apache.org>
Committed: Thu Sep 17 16:53:08 2015 +0200
----------------------------------------------------------------------
examples/camel-example-swagger-java/pom.xml | 4 ++--
.../java/org/apache/camel/example/rest/User.java | 5 +++--
.../org/apache/camel/example/rest/UserService.java | 2 +-
.../src/main/webapp/WEB-INF/web.xml | 17 +++++------------
4 files changed, 11 insertions(+), 17 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/928a76e8/examples/camel-example-swagger-java/pom.xml
----------------------------------------------------------------------
diff --git a/examples/camel-example-swagger-java/pom.xml b/examples/camel-example-swagger-java/pom.xml
index ae985e14..1218033 100755
--- a/examples/camel-example-swagger-java/pom.xml
+++ b/examples/camel-example-swagger-java/pom.xml
@@ -31,9 +31,9 @@
<packaging>war</packaging>
<properties>
- <swagger-ui.version>2.0.24</swagger-ui.version>
+ <swagger-ui.version>2.1.2</swagger-ui.version>
<logback-version>1.1.3</logback-version>
- <swagger.url>https://github.com/swagger-api/swagger-ui/archive/v${swagger-ui.version}</swagger.url>
+ <swagger.url>https://github.com/swagger-api/swagger-ui/archive</swagger.url>
<destDir>target/swagger-ui</destDir>
</properties>
http://git-wip-us.apache.org/repos/asf/camel/blob/928a76e8/examples/camel-example-swagger-java/src/main/java/org/apache/camel/example/rest/User.java
----------------------------------------------------------------------
diff --git a/examples/camel-example-swagger-java/src/main/java/org/apache/camel/example/rest/User.java b/examples/camel-example-swagger-java/src/main/java/org/apache/camel/example/rest/User.java
index ee63727..a1c6b87 100644
--- a/examples/camel-example-swagger-java/src/main/java/org/apache/camel/example/rest/User.java
+++ b/examples/camel-example-swagger-java/src/main/java/org/apache/camel/example/rest/User.java
@@ -16,8 +16,9 @@
*/
package org.apache.camel.example.rest;
-import com.wordnik.swagger.annotations.ApiModel;
-import com.wordnik.swagger.annotations.ApiModelProperty;
+
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
@ApiModel(description = "Represents an user of the system")
public class User {
http://git-wip-us.apache.org/repos/asf/camel/blob/928a76e8/examples/camel-example-swagger-java/src/main/java/org/apache/camel/example/rest/UserService.java
----------------------------------------------------------------------
diff --git a/examples/camel-example-swagger-java/src/main/java/org/apache/camel/example/rest/UserService.java b/examples/camel-example-swagger-java/src/main/java/org/apache/camel/example/rest/UserService.java
index a94942e..c4a11f3 100644
--- a/examples/camel-example-swagger-java/src/main/java/org/apache/camel/example/rest/UserService.java
+++ b/examples/camel-example-swagger-java/src/main/java/org/apache/camel/example/rest/UserService.java
@@ -22,7 +22,7 @@ import java.util.Random;
import java.util.TreeMap;
/**
- * A {@link org.apache.camel.example.rest.User} service which we rest enable from the {@link org.apache.camel.example.rest.UserRouteBuilder}.
+ * A {@link org.apache.camel.example.rest.User} service which we rest enable the routes defined in the XML file.
*/
public class UserService {
http://git-wip-us.apache.org/repos/asf/camel/blob/928a76e8/examples/camel-example-swagger-java/src/main/webapp/WEB-INF/web.xml
----------------------------------------------------------------------
diff --git a/examples/camel-example-swagger-java/src/main/webapp/WEB-INF/web.xml b/examples/camel-example-swagger-java/src/main/webapp/WEB-INF/web.xml
index 3cd24b4..17e049f 100755
--- a/examples/camel-example-swagger-java/src/main/webapp/WEB-INF/web.xml
+++ b/examples/camel-example-swagger-java/src/main/webapp/WEB-INF/web.xml
@@ -25,13 +25,7 @@
<!-- location of Camel Spring xml files -->
<context-param>
<param-name>contextConfigLocation</param-name>
-
- <!-- to use Java DSL -->
- <param-value>classpath:camel-config.xml</param-value>
-
- <!-- to use XML DSL, then enable me, and disable Java DSL above
<param-value>classpath:camel-config-xml.xml</param-value>
- -->
</context-param>
<!-- the listener that kick-starts Spring -->
@@ -51,7 +45,7 @@
<!-- to setup Camel Swagger api servlet -->
<servlet>
<servlet-name>ApiDeclarationServlet</servlet-name>
- <servlet-class>org.apache.camel.component.swagger.DefaultCamelSwaggerServlet</servlet-class>
+ <servlet-class>org.apache.camel.swagger.DefaultCamelSwaggerServlet</servlet-class>
<init-param>
<!-- we specify the base.path using relative notation, that means the actual path will be calculated at runtime as
http://server:port/contextpath/rest -->
@@ -66,7 +60,7 @@
</init-param>
<init-param>
<param-name>api.version</param-name>
- <param-value>1.2.3</param-value>
+ <param-value>2.0</param-value>
</init-param>
<init-param>
<param-name>api.title</param-name>
@@ -92,11 +86,10 @@
<url-pattern>/rest/*</url-pattern>
</servlet-mapping>
- <!-- START SNIPPET: e2 -->
- <!-- enable CORS filter so people can use swagger ui to browse and test the apis -->
+ <!-- enable CORS filter so people can use swagger ui to browse and test the apis
<filter>
<filter-name>RestSwaggerCorsFilter</filter-name>
- <filter-class>org.apache.camel.component.swagger.RestSwaggerCorsFilter</filter-class>
+ <filter-class>org.apache.camel.swagger.RestSwaggerCorsFilter</filter-class>
</filter>
<filter-mapping>
@@ -104,7 +97,7 @@
<url-pattern>/api-docs/*</url-pattern>
<url-pattern>/rest/*</url-pattern>
</filter-mapping>
- <!-- END SNIPPET: e2 -->
+ -->
<welcome-file-list>
<welcome-file>home.html</welcome-file>
[3/8] camel git commit: CAMEL-7800: camel-swagger-java - work in
progress
Posted by da...@apache.org.
CAMEL-7800: camel-swagger-java - work in progress
Project: http://git-wip-us.apache.org/repos/asf/camel/repo
Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/5925c045
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/5925c045
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/5925c045
Branch: refs/heads/swagger
Commit: 5925c045dd5a4f21951845777c1581094471e711
Parents: 1364c95
Author: Claus Ibsen <da...@apache.org>
Authored: Thu Sep 17 15:51:59 2015 +0200
Committer: Claus Ibsen <da...@apache.org>
Committed: Thu Sep 17 15:51:59 2015 +0200
----------------------------------------------------------------------
.../apache/camel/swagger/RestSwaggerReader.java | 40 +++++++++++++++++---
.../camel/swagger/RestSwaggerReaderTest.java | 29 +++++++++-----
.../src/test/resources/log4j.properties | 6 +--
3 files changed, 57 insertions(+), 18 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/5925c045/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/RestSwaggerReader.java
----------------------------------------------------------------------
diff --git a/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/RestSwaggerReader.java b/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/RestSwaggerReader.java
index 4a896a3..de2de46 100644
--- a/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/RestSwaggerReader.java
+++ b/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/RestSwaggerReader.java
@@ -22,17 +22,26 @@ import java.util.Comparator;
import java.util.List;
import java.util.Locale;
-import io.swagger.config.SwaggerConfig;
+import io.swagger.jaxrs.config.BeanConfig;
import io.swagger.models.Operation;
import io.swagger.models.Path;
import io.swagger.models.Swagger;
+import io.swagger.models.parameters.BodyParameter;
+import io.swagger.models.parameters.FormParameter;
+import io.swagger.models.parameters.HeaderParameter;
+import io.swagger.models.parameters.Parameter;
+import io.swagger.models.parameters.PathParameter;
+import io.swagger.models.parameters.QueryParameter;
import org.apache.camel.model.rest.RestDefinition;
+import org.apache.camel.model.rest.RestOperationParamDefinition;
+import org.apache.camel.model.rest.RestParamType;
import org.apache.camel.model.rest.VerbDefinition;
public class RestSwaggerReader {
- public Swagger read(RestDefinition rest) {
+ public Swagger read(RestDefinition rest, BeanConfig config) {
Swagger swagger = new Swagger();
+ config.configure(swagger);
List<VerbDefinition> verbs = new ArrayList<>(rest.getVerbs());
// must sort the verbs by uri so we group them together when an uri has multiple operations
@@ -45,12 +54,9 @@ public class RestSwaggerReader {
for (VerbDefinition verb : verbs) {
- // TODO: should be base path and a lot more
-
-
// the method must be in lower case
String method = verb.asVerb().toLowerCase(Locale.US);
-
+ // operation path is a key
String opPath = getPath(basePath, verb.getUri());
Operation op = new Operation();
@@ -71,6 +77,28 @@ public class RestSwaggerReader {
if (verb.getDescriptionText() != null) {
op.summary(verb.getDescriptionText());
}
+ for (RestOperationParamDefinition param : verb.getParams()) {
+ Parameter parameter = null;
+ if (param.getType().equals(RestParamType.body)) {
+ parameter = new BodyParameter();
+ } else if (param.getType().equals(RestParamType.form)) {
+ parameter = new FormParameter();
+ } else if (param.getType().equals(RestParamType.header)) {
+ parameter = new HeaderParameter();
+ } else if (param.getType().equals(RestParamType.path)) {
+ parameter = new PathParameter();
+ } else if (param.getType().equals(RestParamType.query)) {
+ parameter = new QueryParameter();
+ }
+
+ if (parameter != null) {
+ parameter.setName(param.getName());
+ parameter.setAccess(param.getAccess());
+ parameter.setDescription(param.getDescription());
+ parameter.setRequired(param.getRequired());
+ op.addParameter(parameter);
+ }
+ }
// add path
swagger.path(opPath, path);
http://git-wip-us.apache.org/repos/asf/camel/blob/5925c045/components/camel-swagger-java/src/test/java/org/apache/camel/swagger/RestSwaggerReaderTest.java
----------------------------------------------------------------------
diff --git a/components/camel-swagger-java/src/test/java/org/apache/camel/swagger/RestSwaggerReaderTest.java b/components/camel-swagger-java/src/test/java/org/apache/camel/swagger/RestSwaggerReaderTest.java
index 2252479..6ee65ea 100644
--- a/components/camel-swagger-java/src/test/java/org/apache/camel/swagger/RestSwaggerReaderTest.java
+++ b/components/camel-swagger-java/src/test/java/org/apache/camel/swagger/RestSwaggerReaderTest.java
@@ -24,6 +24,7 @@ import io.swagger.models.Swagger;
import org.apache.camel.builder.RouteBuilder;
import org.apache.camel.impl.JndiRegistry;
import org.apache.camel.model.rest.RestDefinition;
+import org.apache.camel.model.rest.RestParamType;
import org.apache.camel.test.junit4.CamelTestSupport;
import org.junit.Test;
@@ -42,9 +43,15 @@ public class RestSwaggerReaderTest extends CamelTestSupport {
@Override
public void configure() throws Exception {
rest("/hello")
- .get("/hi").to("log:hi")
- .get("/bye").to("log:bye")
- .post("/bye").to("log:bye");
+ .get("/hi/{name}").description("Saying hi")
+ .param().name("name").type(RestParamType.path).dataType("string").description("Who is it").endParam()
+ .to("log:hi")
+ .get("/bye/{name}").description("Saying bye")
+ .param().name("name").type(RestParamType.path).dataType("string").description("Who is it").endParam()
+ .to("log:bye")
+ .post("/bye").description("To update the greeting message")
+ .param().name("greeting").type(RestParamType.body).dataType("string").description("Message to use as greeting").endParam()
+ .to("log:bye");
}
};
}
@@ -55,10 +62,12 @@ public class RestSwaggerReaderTest extends CamelTestSupport {
assertNotNull(rest);
BeanConfig config = new BeanConfig();
- config.setBasePath("http://localhost:8080/api");
+ config.setHost("localhost:8080");
+ config.setSchemes(new String[]{"http"});
+ config.setBasePath("/api");
RestSwaggerReader reader = new RestSwaggerReader();
- Swagger swagger = reader.read(rest);
+ Swagger swagger = reader.read(rest, config);
assertNotNull(swagger);
ObjectMapper mapper = new ObjectMapper();
@@ -68,10 +77,12 @@ public class RestSwaggerReaderTest extends CamelTestSupport {
log.info(json);
- assertTrue(json.contains("\"basePath\":\"http://localhost:8080/api\""));
- assertTrue(json.contains("\"resourcePath\":\"/hello\""));
- assertTrue(json.contains("\"method\":\"GET\""));
- assertTrue(json.contains("\"nickname\":\"getHelloHi\""));
+ assertTrue(json.contains("\"host\" : \"localhost:8080\""));
+ assertTrue(json.contains("\"basePath\" : \"/api\""));
+ assertTrue(json.contains("\"/hello//bye\""));
+ assertTrue(json.contains("\"summary\" : \"To update the greeting message\""));
+ assertTrue(json.contains("\"/hello//bye/{name}\""));
+ assertTrue(json.contains("\"/hello//hi/{name}\""));
context.stop();
}
http://git-wip-us.apache.org/repos/asf/camel/blob/5925c045/components/camel-swagger-java/src/test/resources/log4j.properties
----------------------------------------------------------------------
diff --git a/components/camel-swagger-java/src/test/resources/log4j.properties b/components/camel-swagger-java/src/test/resources/log4j.properties
index 36983fa..6e040b0 100644
--- a/components/camel-swagger-java/src/test/resources/log4j.properties
+++ b/components/camel-swagger-java/src/test/resources/log4j.properties
@@ -18,11 +18,11 @@
#
# The logging properties used for testing.
#
-log4j.rootLogger=INFO, out
+log4j.rootLogger=INFO, file
# uncomment the following to enable camel debugging
-#log4j.logger.org.apache.camel.component.swagger=TRACE
-#log4j.logger.com.wordnik.swagger=DEBUG
+#log4j.logger.org.apache.camel.swagger=TRACE
+#log4j.logger.io.swagger=DEBUG
# CONSOLE appender not used by default
log4j.appender.out=org.apache.log4j.ConsoleAppender
[5/8] camel git commit: CAMEL-7800: camel-swagger-java example
Posted by da...@apache.org.
CAMEL-7800: camel-swagger-java example
Project: http://git-wip-us.apache.org/repos/asf/camel/repo
Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/168bfe59
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/168bfe59
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/168bfe59
Branch: refs/heads/swagger
Commit: 168bfe59b4e57a9f52fd728e5787a31424b3733b
Parents: 4741cec
Author: Claus Ibsen <da...@apache.org>
Authored: Thu Sep 17 16:35:23 2015 +0200
Committer: Claus Ibsen <da...@apache.org>
Committed: Thu Sep 17 16:35:23 2015 +0200
----------------------------------------------------------------------
apache-camel/pom.xml | 4 +
examples/camel-example-swagger-java/pom.xml | 209 +++++++++++++++++++
.../org/apache/camel/example/rest/User.java | 53 +++++
.../apache/camel/example/rest/UserService.java | 76 +++++++
.../src/main/resources/META-INF/LICENSE.txt | 203 ++++++++++++++++++
.../src/main/resources/META-INF/NOTICE.txt | 11 +
.../src/main/resources/camel-config-xml.xml | 72 +++++++
.../src/main/resources/log4j.properties | 30 +++
.../src/main/webapp/META-INF/LICENSE.txt | 203 ++++++++++++++++++
.../src/main/webapp/META-INF/NOTICE.txt | 11 +
.../src/main/webapp/WEB-INF/web.xml | 113 ++++++++++
.../src/main/webapp/home.html | 102 +++++++++
examples/pom.xml | 1 +
parent/pom.xml | 5 +
14 files changed, 1093 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/168bfe59/apache-camel/pom.xml
----------------------------------------------------------------------
diff --git a/apache-camel/pom.xml b/apache-camel/pom.xml
index 0fbf4e9..a370671 100644
--- a/apache-camel/pom.xml
+++ b/apache-camel/pom.xml
@@ -748,6 +748,10 @@
</dependency>
<dependency>
<groupId>org.apache.camel</groupId>
+ <artifactId>camel-swagger-java</artifactId>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.camel</groupId>
<artifactId>camel-sql</artifactId>
</dependency>
<dependency>
http://git-wip-us.apache.org/repos/asf/camel/blob/168bfe59/examples/camel-example-swagger-java/pom.xml
----------------------------------------------------------------------
diff --git a/examples/camel-example-swagger-java/pom.xml b/examples/camel-example-swagger-java/pom.xml
new file mode 100755
index 0000000..ae985e14
--- /dev/null
+++ b/examples/camel-example-swagger-java/pom.xml
@@ -0,0 +1,209 @@
+<?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.
+-->
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+
+ <modelVersion>4.0.0</modelVersion>
+
+ <parent>
+ <groupId>org.apache.camel</groupId>
+ <artifactId>examples</artifactId>
+ <version>2.16-SNAPSHOT</version>
+ </parent>
+
+ <artifactId>camel-example-swagger-java</artifactId>
+ <name>Camel :: Example :: Swagger Java</name>
+ <description>An example using REST DSL and Swagger Java with Apache Tomcat</description>
+ <packaging>war</packaging>
+
+ <properties>
+ <swagger-ui.version>2.0.24</swagger-ui.version>
+ <logback-version>1.1.3</logback-version>
+ <swagger.url>https://github.com/swagger-api/swagger-ui/archive/v${swagger-ui.version}</swagger.url>
+ <destDir>target/swagger-ui</destDir>
+ </properties>
+
+ <dependencies>
+
+ <!-- camel -->
+ <dependency>
+ <groupId>org.apache.camel</groupId>
+ <artifactId>camel-core</artifactId>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.camel</groupId>
+ <artifactId>camel-spring</artifactId>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.camel</groupId>
+ <artifactId>camel-servlet</artifactId>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.camel</groupId>
+ <artifactId>camel-metrics</artifactId>
+ </dependency>
+
+ <!-- swagger api -->
+ <dependency>
+ <groupId>org.apache.camel</groupId>
+ <artifactId>camel-swagger-java</artifactId>
+ </dependency>
+
+ <!-- use for json binding -->
+ <dependency>
+ <groupId>org.apache.camel</groupId>
+ <artifactId>camel-jackson</artifactId>
+ </dependency>
+
+ <!-- we need spring web -->
+ <dependency>
+ <groupId>org.springframework</groupId>
+ <artifactId>spring-web</artifactId>
+ </dependency>
+
+ <!-- logging -->
+ <dependency>
+ <groupId>log4j</groupId>
+ <artifactId>log4j</artifactId>
+ </dependency>
+ <dependency>
+ <groupId>org.slf4j</groupId>
+ <artifactId>slf4j-log4j12</artifactId>
+ </dependency>
+ <dependency>
+ <groupId>ch.qos.logback</groupId>
+ <artifactId>logback-classic</artifactId>
+ <version>${logback-version}</version>
+ </dependency>
+ <dependency>
+ <groupId>ch.qos.logback</groupId>
+ <artifactId>logback-core</artifactId>
+ <version>${logback-version}</version>
+ </dependency>
+ </dependencies>
+
+ <build>
+ <!-- we do not want version in the WAR name -->
+ <finalName>${project.artifactId}</finalName>
+
+ <plugins>
+ <!-- Step 1. - Download Swagger UI project from GitHub -->
+ <plugin>
+ <groupId>org.codehaus.mojo</groupId>
+ <artifactId>wagon-maven-plugin</artifactId>
+ <version>1.0</version>
+ <executions>
+ <execution>
+ <phase>process-resources</phase>
+ <goals>
+ <goal>download-single</goal>
+ </goals>
+ <configuration>
+ <url>${swagger.url}</url>
+ <fromFile>v${swagger-ui.version}.tar.gz</fromFile>
+ <toFile>${project.build.directory}/swagger-ui-${swagger-ui.version}.tar.gz</toFile>
+ </configuration>
+ </execution>
+ </executions>
+ </plugin>
+
+ <!-- Step 2. - Decompress content and move it to target/swagger-ui folder -->
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-antrun-plugin</artifactId>
+ <executions>
+ <execution>
+ <phase>process-resources</phase>
+ <goals>
+ <goal>run</goal>
+ </goals>
+ <configuration>
+ <target>
+ <echo message="Decompress archive" />
+ <gunzip src="${project.build.directory}/swagger-ui-${swagger-ui.version}.tar.gz" />
+ <untar src="${project.build.directory}/swagger-ui-${swagger-ui.version}.tar" dest="${project.build.directory}" />
+ <echo message="moving resources" />
+ <move todir="${destDir}" overwrite="yes">
+ <fileset dir="${project.build.directory}/swagger-ui-${swagger-ui.version}/dist" />
+ </move>
+ </target>
+ </configuration>
+ </execution>
+ </executions>
+ </plugin>
+
+ <!-- Step 3. Copy Web Resources to target/classes but also to target/swagger-ui -->
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-resources-plugin</artifactId>
+ <executions>
+ <execution>
+ <id>copy-resources</id>
+ <phase>generate-resources</phase>
+ <goals>
+ <goal>copy-resources</goal>
+ </goals>
+ <configuration>
+ <outputDirectory>${basedir}/target/classes/</outputDirectory>
+ <resources>
+ <resource>
+ <directory>src/main/webapp</directory>
+ <filtering>false</filtering>
+ </resource>
+ <!-- Copy swagger-ui resources to classes directory to be able to use it with mvn jetty:run -->
+ <resource>
+ <directory>${destDir}</directory>
+ <filtering>false</filtering>
+ </resource>
+ </resources>
+ </configuration>
+ </execution>
+ </executions>
+ </plugin>
+
+ <!-- Step 4. Add Swagger-ui Resources to the WAR -->
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-war-plugin</artifactId>
+ <configuration>
+ <webResources>
+ <resource>
+ <directory>target/swagger-ui/</directory>
+ <includes>
+ <include>**/*.*</include>
+ </includes>
+ </resource>
+ </webResources>
+ </configuration>
+ </plugin>
+
+ <!-- allows running this example with mvn:jetty-run -->
+ <plugin>
+ <groupId>org.eclipse.jetty</groupId>
+ <artifactId>jetty-maven-plugin</artifactId>
+ <version>${jetty9-version}</version>
+ <configuration>
+ <webAppSourceDirectory>target/classes</webAppSourceDirectory>
+ <webApp>
+ <contextPath>/${project.artifactId}</contextPath>
+ </webApp>
+ </configuration>
+ </plugin>
+ </plugins>
+ </build>
+
+</project>
http://git-wip-us.apache.org/repos/asf/camel/blob/168bfe59/examples/camel-example-swagger-java/src/main/java/org/apache/camel/example/rest/User.java
----------------------------------------------------------------------
diff --git a/examples/camel-example-swagger-java/src/main/java/org/apache/camel/example/rest/User.java b/examples/camel-example-swagger-java/src/main/java/org/apache/camel/example/rest/User.java
new file mode 100644
index 0000000..ee63727
--- /dev/null
+++ b/examples/camel-example-swagger-java/src/main/java/org/apache/camel/example/rest/User.java
@@ -0,0 +1,53 @@
+/**
+ * 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.
+ */
+package org.apache.camel.example.rest;
+
+import com.wordnik.swagger.annotations.ApiModel;
+import com.wordnik.swagger.annotations.ApiModelProperty;
+
+@ApiModel(description = "Represents an user of the system")
+public class User {
+
+ private int id;
+ private String name;
+
+ public User() {
+ }
+
+ public User(int id, String name) {
+ this.id = id;
+ this.name = name;
+ }
+
+ @ApiModelProperty(value = "The id of the user", required = true)
+ public int getId() {
+ return id;
+ }
+
+ public void setId(int id) {
+ this.id = id;
+ }
+
+ @ApiModelProperty(value = "The name of the user", required = true)
+ public String getName() {
+ return name;
+ }
+
+ public void setName(String name) {
+ this.name = name;
+ }
+}
http://git-wip-us.apache.org/repos/asf/camel/blob/168bfe59/examples/camel-example-swagger-java/src/main/java/org/apache/camel/example/rest/UserService.java
----------------------------------------------------------------------
diff --git a/examples/camel-example-swagger-java/src/main/java/org/apache/camel/example/rest/UserService.java b/examples/camel-example-swagger-java/src/main/java/org/apache/camel/example/rest/UserService.java
new file mode 100644
index 0000000..a94942e
--- /dev/null
+++ b/examples/camel-example-swagger-java/src/main/java/org/apache/camel/example/rest/UserService.java
@@ -0,0 +1,76 @@
+/**
+ * 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.
+ */
+package org.apache.camel.example.rest;
+
+import java.util.Collection;
+import java.util.Map;
+import java.util.Random;
+import java.util.TreeMap;
+
+/**
+ * A {@link org.apache.camel.example.rest.User} service which we rest enable from the {@link org.apache.camel.example.rest.UserRouteBuilder}.
+ */
+public class UserService {
+
+ // use a tree map so they become sorted
+ private final Map<String, User> users = new TreeMap<String, User>();
+
+ private Random ran = new Random();
+
+ public UserService() {
+ users.put("123", new User(123, "John Doe"));
+ users.put("456", new User(456, "Donald Duck"));
+ users.put("789", new User(789, "Slow Turtle"));
+ }
+
+ /**
+ * Gets a user by the given id
+ *
+ * @param id the id of the user
+ * @return the user, or <tt>null</tt> if no user exists
+ */
+ public User getUser(String id) {
+ if ("789".equals(id)) {
+ // simulate some cpu processing time when returning the slow turtle
+ int delay = 500 + ran.nextInt(1500);
+ try {
+ Thread.sleep(delay);
+ } catch (Exception e) {
+ // ignore
+ }
+ }
+ return users.get(id);
+ }
+
+ /**
+ * List all users
+ *
+ * @return the list of all users
+ */
+ public Collection<User> listUsers() {
+ return users.values();
+ }
+
+ /**
+ * Updates or creates the given user
+ *
+ * @param user the user
+ */
+ public void updateUser(User user) {
+ users.put("" + user.getId(), user);
+ }
+}
http://git-wip-us.apache.org/repos/asf/camel/blob/168bfe59/examples/camel-example-swagger-java/src/main/resources/META-INF/LICENSE.txt
----------------------------------------------------------------------
diff --git a/examples/camel-example-swagger-java/src/main/resources/META-INF/LICENSE.txt b/examples/camel-example-swagger-java/src/main/resources/META-INF/LICENSE.txt
new file mode 100644
index 0000000..6b0b127
--- /dev/null
+++ b/examples/camel-example-swagger-java/src/main/resources/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/168bfe59/examples/camel-example-swagger-java/src/main/resources/META-INF/NOTICE.txt
----------------------------------------------------------------------
diff --git a/examples/camel-example-swagger-java/src/main/resources/META-INF/NOTICE.txt b/examples/camel-example-swagger-java/src/main/resources/META-INF/NOTICE.txt
new file mode 100644
index 0000000..2e215bf
--- /dev/null
+++ b/examples/camel-example-swagger-java/src/main/resources/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/168bfe59/examples/camel-example-swagger-java/src/main/resources/camel-config-xml.xml
----------------------------------------------------------------------
diff --git a/examples/camel-example-swagger-java/src/main/resources/camel-config-xml.xml b/examples/camel-example-swagger-java/src/main/resources/camel-config-xml.xml
new file mode 100755
index 0000000..cd6fdf0
--- /dev/null
+++ b/examples/camel-example-swagger-java/src/main/resources/camel-config-xml.xml
@@ -0,0 +1,72 @@
+<?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">
+
+ <!-- use camel-metrics route policy to gather metrics for all routes -->
+ <bean id="metricsRoutePolicyFactory" class="org.apache.camel.component.metrics.routepolicy.MetricsRoutePolicyFactory"/>
+
+ <!-- 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 -->
+ <restConfiguration component="servlet" bindingMode="json" contextPath="camel-example-servlet-rest-tomcat/rest" port="8080">
+ <dataFormatProperty key="prettyPrint" value="true"/>
+ </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="int"/>
+ <to uri="bean:userService?method=getUser(${header.id})"/>
+ </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>
+ <to uri="bean:userService?method=listUsers"/>
+ </get>
+ </rest>
+
+ </camelContext>
+
+</beans>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/camel/blob/168bfe59/examples/camel-example-swagger-java/src/main/resources/log4j.properties
----------------------------------------------------------------------
diff --git a/examples/camel-example-swagger-java/src/main/resources/log4j.properties b/examples/camel-example-swagger-java/src/main/resources/log4j.properties
new file mode 100755
index 0000000..ed9a8f1
--- /dev/null
+++ b/examples/camel-example-swagger-java/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/168bfe59/examples/camel-example-swagger-java/src/main/webapp/META-INF/LICENSE.txt
----------------------------------------------------------------------
diff --git a/examples/camel-example-swagger-java/src/main/webapp/META-INF/LICENSE.txt b/examples/camel-example-swagger-java/src/main/webapp/META-INF/LICENSE.txt
new file mode 100644
index 0000000..6b0b127
--- /dev/null
+++ b/examples/camel-example-swagger-java/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/168bfe59/examples/camel-example-swagger-java/src/main/webapp/META-INF/NOTICE.txt
----------------------------------------------------------------------
diff --git a/examples/camel-example-swagger-java/src/main/webapp/META-INF/NOTICE.txt b/examples/camel-example-swagger-java/src/main/webapp/META-INF/NOTICE.txt
new file mode 100644
index 0000000..2e215bf
--- /dev/null
+++ b/examples/camel-example-swagger-java/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/168bfe59/examples/camel-example-swagger-java/src/main/webapp/WEB-INF/web.xml
----------------------------------------------------------------------
diff --git a/examples/camel-example-swagger-java/src/main/webapp/WEB-INF/web.xml b/examples/camel-example-swagger-java/src/main/webapp/WEB-INF/web.xml
new file mode 100755
index 0000000..3cd24b4
--- /dev/null
+++ b/examples/camel-example-swagger-java/src/main/webapp/WEB-INF/web.xml
@@ -0,0 +1,113 @@
+<?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>
+
+ <!-- to use Java DSL -->
+ <param-value>classpath:camel-config.xml</param-value>
+
+ <!-- to use XML DSL, then enable me, and disable Java DSL above
+ <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>
+
+ <!-- START SNIPPET: e1 -->
+ <!-- to setup Camel Swagger api servlet -->
+ <servlet>
+ <servlet-name>ApiDeclarationServlet</servlet-name>
+ <servlet-class>org.apache.camel.component.swagger.DefaultCamelSwaggerServlet</servlet-class>
+ <init-param>
+ <!-- we specify the base.path using relative notation, that means the actual path will be calculated at runtime as
+ http://server:port/contextpath/rest -->
+ <param-name>base.path</param-name>
+ <param-value>rest</param-value>
+ </init-param>
+ <init-param>
+ <!-- we specify the api.path using relative notation, that means the actual path will be calculated at runtime as
+ http://server:port/contextpath/api-docs -->
+ <param-name>api.path</param-name>
+ <param-value>api-docs</param-value>
+ </init-param>
+ <init-param>
+ <param-name>api.version</param-name>
+ <param-value>1.2.3</param-value>
+ </init-param>
+ <init-param>
+ <param-name>api.title</param-name>
+ <param-value>User Services</param-value>
+ </init-param>
+ <init-param>
+ <param-name>api.description</param-name>
+ <param-value>Camel Rest Example with Swagger that provides an User REST service</param-value>
+ </init-param>
+ <load-on-startup>2</load-on-startup>
+ </servlet>
+
+ <!-- swagger api declaration -->
+ <servlet-mapping>
+ <servlet-name>ApiDeclarationServlet</servlet-name>
+ <url-pattern>/api-docs/*</url-pattern>
+ </servlet-mapping>
+ <!-- END SNIPPET: e1 -->
+
+ <!-- define that url path for the Camel Servlet to use -->
+ <servlet-mapping>
+ <servlet-name>CamelServlet</servlet-name>
+ <url-pattern>/rest/*</url-pattern>
+ </servlet-mapping>
+
+ <!-- START SNIPPET: e2 -->
+ <!-- enable CORS filter so people can use swagger ui to browse and test the apis -->
+ <filter>
+ <filter-name>RestSwaggerCorsFilter</filter-name>
+ <filter-class>org.apache.camel.component.swagger.RestSwaggerCorsFilter</filter-class>
+ </filter>
+
+ <filter-mapping>
+ <filter-name>RestSwaggerCorsFilter</filter-name>
+ <url-pattern>/api-docs/*</url-pattern>
+ <url-pattern>/rest/*</url-pattern>
+ </filter-mapping>
+ <!-- END SNIPPET: e2 -->
+
+ <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/168bfe59/examples/camel-example-swagger-java/src/main/webapp/home.html
----------------------------------------------------------------------
diff --git a/examples/camel-example-swagger-java/src/main/webapp/home.html b/examples/camel-example-swagger-java/src/main/webapp/home.html
new file mode 100644
index 0000000..b9c4e2a
--- /dev/null
+++ b/examples/camel-example-swagger-java/src/main/webapp/home.html
@@ -0,0 +1,102 @@
+<!--
+ 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 Servlet REST and Apache Tomcat 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 Servlet REST & Web Container</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
+
+ <br/>
+
+ This example is implemented in both the Java and XML DSLs. By default the Java DSL is in use.
+ You can change this in the src/main/webapps/WEB-INF/web.xml file
+
+ <br/>
+ For Java DSL the routes are defined in Java code, in the <tt>org.apache.camel.example.rest.UserRouteBuilder</tt>
+ class.
+ And for 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-servlet-rest-tomcat/rest/user/123
+ curl -X GET -H "Accept: application/json" http://localhost:8080/camel-example-servlet-rest-tomcat/rest/user/findAll
+ curl -X PUT -d "{ \"id\": 666, \"name\": \"The devil\"}" -H "Accept: application/json" http://localhost:8080/camel-example-servlet-rest-tomcat/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="api-docs">api-docs</a> - list all CamelContexts in the JVM that may have REST services</li>
+ <li><a href="api-docs/myCamel">api-docs/myCamel</a> - myCamel - overview of the apis from the REST services</li>
+ <li><a href="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-servlet-rest-tomcat/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/168bfe59/examples/pom.xml
----------------------------------------------------------------------
diff --git a/examples/pom.xml b/examples/pom.xml
index cdade2a..1d41204 100644
--- a/examples/pom.xml
+++ b/examples/pom.xml
@@ -82,6 +82,7 @@
<module>camel-example-ssh-security</module>
<module>camel-example-sql</module>
<module>camel-example-sql-blueprint</module>
+ <module>camel-example-swagger-java</module>
<module>camel-example-tracer</module>
<module>camel-example-twitter-websocket</module>
<module>camel-example-twitter-websocket-blueprint</module>
http://git-wip-us.apache.org/repos/asf/camel/blob/168bfe59/parent/pom.xml
----------------------------------------------------------------------
diff --git a/parent/pom.xml b/parent/pom.xml
index f594bba..6e44176 100644
--- a/parent/pom.xml
+++ b/parent/pom.xml
@@ -1523,6 +1523,11 @@
</dependency>
<dependency>
<groupId>org.apache.camel</groupId>
+ <artifactId>camel-swagger-java</artifactId>
+ <version>${project.version}</version>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.camel</groupId>
<artifactId>camel-tagsoup</artifactId>
<version>${project.version}</version>
</dependency>
[8/8] camel git commit: CAMEL-7800: camel-swagger-java - work in
progress
Posted by da...@apache.org.
CAMEL-7800: camel-swagger-java - work in progress
Project: http://git-wip-us.apache.org/repos/asf/camel/repo
Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/03c407c9
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/03c407c9
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/03c407c9
Branch: refs/heads/swagger
Commit: 03c407c94eef391ad724e2afcb2429906e36dfb1
Parents: 3d67261
Author: Claus Ibsen <da...@apache.org>
Authored: Thu Sep 17 17:16:50 2015 +0200
Committer: Claus Ibsen <da...@apache.org>
Committed: Thu Sep 17 17:16:50 2015 +0200
----------------------------------------------------------------------
.../RestSwaggerApiDeclarationServlet.java | 4 ++-
.../apache/camel/swagger/RestSwaggerReader.java | 25 ++++++-------
.../org/apache/camel/swagger/SwaggerHelper.java | 37 ++++++++++++++++++++
3 files changed, 50 insertions(+), 16 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/03c407c9/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/RestSwaggerApiDeclarationServlet.java
----------------------------------------------------------------------
diff --git a/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/RestSwaggerApiDeclarationServlet.java b/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/RestSwaggerApiDeclarationServlet.java
index 9a918b2..ceb5af2 100644
--- a/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/RestSwaggerApiDeclarationServlet.java
+++ b/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/RestSwaggerApiDeclarationServlet.java
@@ -35,6 +35,8 @@ import org.apache.camel.model.rest.RestDefinition;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
+import static org.apache.camel.swagger.SwaggerHelper.buildUrl;
+
public abstract class RestSwaggerApiDeclarationServlet extends HttpServlet {
private Logger LOG = LoggerFactory.getLogger(RestSwaggerApiDeclarationServlet.class);
@@ -168,7 +170,7 @@ public abstract class RestSwaggerApiDeclarationServlet extends HttpServlet {
} else {
swaggerConfig.setHost(url.getHost());
}
- swaggerConfig.setBasePath(path + "/" + base);
+ swaggerConfig.setBasePath(buildUrl(path, base));
}
initDone = true;
}
http://git-wip-us.apache.org/repos/asf/camel/blob/03c407c9/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/RestSwaggerReader.java
----------------------------------------------------------------------
diff --git a/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/RestSwaggerReader.java b/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/RestSwaggerReader.java
index b343c5f..e6172af 100644
--- a/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/RestSwaggerReader.java
+++ b/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/RestSwaggerReader.java
@@ -33,12 +33,12 @@ import io.swagger.models.parameters.HeaderParameter;
import io.swagger.models.parameters.Parameter;
import io.swagger.models.parameters.PathParameter;
import io.swagger.models.parameters.QueryParameter;
+import io.swagger.models.parameters.SerializableParameter;
import org.apache.camel.model.rest.RestDefinition;
import org.apache.camel.model.rest.RestOperationParamDefinition;
import org.apache.camel.model.rest.RestOperationResponseMsgDefinition;
import org.apache.camel.model.rest.RestParamType;
import org.apache.camel.model.rest.VerbDefinition;
-import org.apache.camel.util.FileUtil;
public class RestSwaggerReader {
@@ -60,7 +60,7 @@ public class RestSwaggerReader {
// the method must be in lower case
String method = verb.asVerb().toLowerCase(Locale.US);
// operation path is a key
- String opPath = buildUrl(basePath, verb.getUri());
+ String opPath = SwaggerHelper.buildUrl(basePath, verb.getUri());
Operation op = new Operation();
@@ -71,6 +71,8 @@ public class RestSwaggerReader {
}
path = path.set(method, op);
+ // TODO: add the type / outType stuff with array and model detection
+
if (verb.getConsumes() != null) {
op.consumes(verb.getConsumes());
} else if (rest.getConsumes() != null) {
@@ -103,6 +105,12 @@ public class RestSwaggerReader {
parameter.setAccess(param.getAccess());
parameter.setDescription(param.getDescription());
parameter.setRequired(param.getRequired());
+
+ if (parameter instanceof SerializableParameter) {
+ SerializableParameter sp = (SerializableParameter) parameter;
+ sp.setType(param.getDataType());
+ }
+
op.addParameter(parameter);
}
}
@@ -121,18 +129,6 @@ public class RestSwaggerReader {
return swagger;
}
- private String buildUrl(String path1, String path2) {
- String s1 = FileUtil.stripTrailingSeparator(path1);
- String s2 = FileUtil.stripLeadingSeparator(path2);
- if (s1 != null && s2 != null) {
- return s1 + "/" + s2;
- } else if (path1 != null) {
- return path1;
- } else {
- return path2;
- }
- }
-
/**
* To sort the rest operations
*/
@@ -161,5 +157,4 @@ public class RestSwaggerReader {
}
}
-
}
http://git-wip-us.apache.org/repos/asf/camel/blob/03c407c9/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/SwaggerHelper.java
----------------------------------------------------------------------
diff --git a/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/SwaggerHelper.java b/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/SwaggerHelper.java
new file mode 100644
index 0000000..eb5124a
--- /dev/null
+++ b/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/SwaggerHelper.java
@@ -0,0 +1,37 @@
+/**
+ * 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.
+ */
+package org.apache.camel.swagger;
+
+import org.apache.camel.util.FileUtil;
+
+public final class SwaggerHelper {
+
+ private SwaggerHelper() {
+ }
+
+ public static String buildUrl(String path1, String path2) {
+ String s1 = FileUtil.stripTrailingSeparator(path1);
+ String s2 = FileUtil.stripLeadingSeparator(path2);
+ if (s1 != null && s2 != null) {
+ return s1 + "/" + s2;
+ } else if (path1 != null) {
+ return path1;
+ } else {
+ return path2;
+ }
+ }
+}
[2/8] camel git commit: CAMEL-7800: camel-swagger-java - work in
progress
Posted by da...@apache.org.
CAMEL-7800: camel-swagger-java - work in progress
Project: http://git-wip-us.apache.org/repos/asf/camel/repo
Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/1364c958
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/1364c958
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/1364c958
Branch: refs/heads/swagger
Commit: 1364c9588d462a3be980d9b2040b305afdb5cfec
Parents: d40c009
Author: Claus Ibsen <da...@apache.org>
Authored: Thu Sep 17 15:02:33 2015 +0200
Committer: Claus Ibsen <da...@apache.org>
Committed: Thu Sep 17 15:02:33 2015 +0200
----------------------------------------------------------------------
.../apache/camel/swagger/RestSwaggerReader.java | 116 +++++++++++++++++++
.../camel/swagger/DummyRestConsumerFactory.java | 48 ++++++++
.../camel/swagger/RestSwaggerReaderTest.java | 79 +++++++++++++
.../src/test/resources/log4j.properties | 2 +-
4 files changed, 244 insertions(+), 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/1364c958/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/RestSwaggerReader.java
----------------------------------------------------------------------
diff --git a/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/RestSwaggerReader.java b/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/RestSwaggerReader.java
new file mode 100644
index 0000000..4a896a3
--- /dev/null
+++ b/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/RestSwaggerReader.java
@@ -0,0 +1,116 @@
+/**
+ * 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.
+ */
+package org.apache.camel.swagger;
+
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.Comparator;
+import java.util.List;
+import java.util.Locale;
+
+import io.swagger.config.SwaggerConfig;
+import io.swagger.models.Operation;
+import io.swagger.models.Path;
+import io.swagger.models.Swagger;
+import org.apache.camel.model.rest.RestDefinition;
+import org.apache.camel.model.rest.VerbDefinition;
+
+public class RestSwaggerReader {
+
+ public Swagger read(RestDefinition rest) {
+ Swagger swagger = new Swagger();
+
+ List<VerbDefinition> verbs = new ArrayList<>(rest.getVerbs());
+ // must sort the verbs by uri so we group them together when an uri has multiple operations
+ Collections.sort(verbs, new VerbOrdering());
+
+ // used during gathering of apis
+ List<Path> paths = new ArrayList<>();
+
+ String basePath = rest.getPath();
+
+ for (VerbDefinition verb : verbs) {
+
+ // TODO: should be base path and a lot more
+
+
+ // the method must be in lower case
+ String method = verb.asVerb().toLowerCase(Locale.US);
+
+ String opPath = getPath(basePath, verb.getUri());
+
+ Operation op = new Operation();
+
+ Path path = swagger.getPath(opPath);
+ if (path == null) {
+ path = new Path();
+ paths.add(path);
+ }
+ path = path.set(method, op);
+
+ if (verb.getConsumes() != null) {
+ op.consumes(verb.getConsumes());
+ }
+ if (verb.getProduces() != null) {
+ op.produces(verb.getProduces());
+ }
+ if (verb.getDescriptionText() != null) {
+ op.summary(verb.getDescriptionText());
+ }
+
+ // add path
+ swagger.path(opPath, path);
+ }
+
+ return swagger;
+ }
+
+ private String getPath(String basePath, String uri) {
+ // TODO: slash check and avoid double slash and all that
+ return basePath + "/" + uri;
+ }
+
+ /**
+ * To sort the rest operations
+ */
+ private static class VerbOrdering implements Comparator<VerbDefinition> {
+
+ @Override
+ public int compare(VerbDefinition a, VerbDefinition b) {
+
+ String u1 = "";
+ if (a.getUri() != null) {
+ // replace { with _ which comes before a when soring by char
+ u1 = a.getUri().replace("{", "_");
+ }
+ String u2 = "";
+ if (b.getUri() != null) {
+ // replace { with _ which comes before a when soring by char
+ u2 = b.getUri().replace("{", "_");
+ }
+
+ int num = u1.compareTo(u2);
+ if (num == 0) {
+ // same uri, so use http method as sorting
+ num = a.asVerb().compareTo(b.asVerb());
+ }
+ return num;
+ }
+ }
+
+
+}
http://git-wip-us.apache.org/repos/asf/camel/blob/1364c958/components/camel-swagger-java/src/test/java/org/apache/camel/swagger/DummyRestConsumerFactory.java
----------------------------------------------------------------------
diff --git a/components/camel-swagger-java/src/test/java/org/apache/camel/swagger/DummyRestConsumerFactory.java b/components/camel-swagger-java/src/test/java/org/apache/camel/swagger/DummyRestConsumerFactory.java
new file mode 100644
index 0000000..d0d6efe
--- /dev/null
+++ b/components/camel-swagger-java/src/test/java/org/apache/camel/swagger/DummyRestConsumerFactory.java
@@ -0,0 +1,48 @@
+/**
+ * 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.
+ */
+package org.apache.camel.swagger;
+
+import java.util.Map;
+
+import org.apache.camel.CamelContext;
+import org.apache.camel.Consumer;
+import org.apache.camel.Processor;
+import org.apache.camel.component.seda.SedaEndpoint;
+import org.apache.camel.impl.ActiveMQUuidGenerator;
+import org.apache.camel.spi.RestConsumerFactory;
+
+public class DummyRestConsumerFactory implements RestConsumerFactory {
+
+ @Override
+ public Consumer createConsumer(CamelContext camelContext, Processor processor, String verb, String basePath, String uriTemplate,
+ String consumes, String produces, Map<String, Object> parameters) throws Exception {
+ // just use a seda endpoint for testing purpose
+ String id;
+ if (uriTemplate != null) {
+ id = ActiveMQUuidGenerator.generateSanitizedId(basePath + uriTemplate);
+ } else {
+ id = ActiveMQUuidGenerator.generateSanitizedId(basePath);
+ }
+ // remove leading dash as we add that ourselves
+ if (id.startsWith("-")) {
+ id = id.substring(1);
+ }
+ SedaEndpoint seda = camelContext.getEndpoint("seda:" + verb + "-" + id, SedaEndpoint.class);
+ return seda.createConsumer(processor);
+ }
+
+}
http://git-wip-us.apache.org/repos/asf/camel/blob/1364c958/components/camel-swagger-java/src/test/java/org/apache/camel/swagger/RestSwaggerReaderTest.java
----------------------------------------------------------------------
diff --git a/components/camel-swagger-java/src/test/java/org/apache/camel/swagger/RestSwaggerReaderTest.java b/components/camel-swagger-java/src/test/java/org/apache/camel/swagger/RestSwaggerReaderTest.java
new file mode 100644
index 0000000..2252479
--- /dev/null
+++ b/components/camel-swagger-java/src/test/java/org/apache/camel/swagger/RestSwaggerReaderTest.java
@@ -0,0 +1,79 @@
+/**
+ * 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.
+ */
+package org.apache.camel.swagger;
+
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.SerializationFeature;
+import io.swagger.jaxrs.config.BeanConfig;
+import io.swagger.models.Swagger;
+import org.apache.camel.builder.RouteBuilder;
+import org.apache.camel.impl.JndiRegistry;
+import org.apache.camel.model.rest.RestDefinition;
+import org.apache.camel.test.junit4.CamelTestSupport;
+import org.junit.Test;
+
+public class RestSwaggerReaderTest extends CamelTestSupport {
+
+ @Override
+ protected JndiRegistry createRegistry() throws Exception {
+ JndiRegistry jndi = super.createRegistry();
+ jndi.bind("dummy-rest", new DummyRestConsumerFactory());
+ return jndi;
+ }
+
+ @Override
+ protected RouteBuilder createRouteBuilder() throws Exception {
+ return new RouteBuilder() {
+ @Override
+ public void configure() throws Exception {
+ rest("/hello")
+ .get("/hi").to("log:hi")
+ .get("/bye").to("log:bye")
+ .post("/bye").to("log:bye");
+ }
+ };
+ }
+
+ @Test
+ public void testReaderRead() throws Exception {
+ RestDefinition rest = context.getRestDefinitions().get(0);
+ assertNotNull(rest);
+
+ BeanConfig config = new BeanConfig();
+ config.setBasePath("http://localhost:8080/api");
+ RestSwaggerReader reader = new RestSwaggerReader();
+
+ Swagger swagger = reader.read(rest);
+ assertNotNull(swagger);
+
+ ObjectMapper mapper = new ObjectMapper();
+ mapper.enable(SerializationFeature.INDENT_OUTPUT);
+ mapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);
+ String json = mapper.writeValueAsString(swagger);
+
+ log.info(json);
+
+ assertTrue(json.contains("\"basePath\":\"http://localhost:8080/api\""));
+ assertTrue(json.contains("\"resourcePath\":\"/hello\""));
+ assertTrue(json.contains("\"method\":\"GET\""));
+ assertTrue(json.contains("\"nickname\":\"getHelloHi\""));
+
+ context.stop();
+ }
+
+}
http://git-wip-us.apache.org/repos/asf/camel/blob/1364c958/components/camel-swagger-java/src/test/resources/log4j.properties
----------------------------------------------------------------------
diff --git a/components/camel-swagger-java/src/test/resources/log4j.properties b/components/camel-swagger-java/src/test/resources/log4j.properties
index 3e0349e..36983fa 100644
--- a/components/camel-swagger-java/src/test/resources/log4j.properties
+++ b/components/camel-swagger-java/src/test/resources/log4j.properties
@@ -18,7 +18,7 @@
#
# The logging properties used for testing.
#
-log4j.rootLogger=INFO, file
+log4j.rootLogger=INFO, out
# uncomment the following to enable camel debugging
#log4j.logger.org.apache.camel.component.swagger=TRACE
[7/8] camel git commit: CAMEL-7800: camel-swagger-java - work in
progress
Posted by da...@apache.org.
CAMEL-7800: camel-swagger-java - work in progress
Project: http://git-wip-us.apache.org/repos/asf/camel/repo
Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/3d672613
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/3d672613
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/3d672613
Branch: refs/heads/swagger
Commit: 3d672613504a297742d9b6145a9806f924aba246
Parents: 928a76e
Author: Claus Ibsen <da...@apache.org>
Authored: Thu Sep 17 16:58:42 2015 +0200
Committer: Claus Ibsen <da...@apache.org>
Committed: Thu Sep 17 16:58:42 2015 +0200
----------------------------------------------------------------------
.../apache/camel/swagger/RestSwaggerReader.java | 18 ++++++++++++++----
.../camel/swagger/RestSwaggerReaderTest.java | 6 +++---
2 files changed, 17 insertions(+), 7 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/3d672613/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/RestSwaggerReader.java
----------------------------------------------------------------------
diff --git a/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/RestSwaggerReader.java b/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/RestSwaggerReader.java
index 662cb34..b343c5f 100644
--- a/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/RestSwaggerReader.java
+++ b/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/RestSwaggerReader.java
@@ -38,6 +38,7 @@ import org.apache.camel.model.rest.RestOperationParamDefinition;
import org.apache.camel.model.rest.RestOperationResponseMsgDefinition;
import org.apache.camel.model.rest.RestParamType;
import org.apache.camel.model.rest.VerbDefinition;
+import org.apache.camel.util.FileUtil;
public class RestSwaggerReader {
@@ -59,7 +60,7 @@ public class RestSwaggerReader {
// the method must be in lower case
String method = verb.asVerb().toLowerCase(Locale.US);
// operation path is a key
- String opPath = getPath(basePath, verb.getUri());
+ String opPath = buildUrl(basePath, verb.getUri());
Operation op = new Operation();
@@ -113,14 +114,23 @@ public class RestSwaggerReader {
// add path
swagger.path(opPath, path);
+
+ // TODO: add model parser for swagger annotations in the model/schema
}
return swagger;
}
- private String getPath(String basePath, String uri) {
- // TODO: slash check and avoid double slash and all that
- return basePath + "/" + uri;
+ private String buildUrl(String path1, String path2) {
+ String s1 = FileUtil.stripTrailingSeparator(path1);
+ String s2 = FileUtil.stripLeadingSeparator(path2);
+ if (s1 != null && s2 != null) {
+ return s1 + "/" + s2;
+ } else if (path1 != null) {
+ return path1;
+ } else {
+ return path2;
+ }
}
/**
http://git-wip-us.apache.org/repos/asf/camel/blob/3d672613/components/camel-swagger-java/src/test/java/org/apache/camel/swagger/RestSwaggerReaderTest.java
----------------------------------------------------------------------
diff --git a/components/camel-swagger-java/src/test/java/org/apache/camel/swagger/RestSwaggerReaderTest.java b/components/camel-swagger-java/src/test/java/org/apache/camel/swagger/RestSwaggerReaderTest.java
index 45aa629..baefb8f 100644
--- a/components/camel-swagger-java/src/test/java/org/apache/camel/swagger/RestSwaggerReaderTest.java
+++ b/components/camel-swagger-java/src/test/java/org/apache/camel/swagger/RestSwaggerReaderTest.java
@@ -80,10 +80,10 @@ public class RestSwaggerReaderTest extends CamelTestSupport {
assertTrue(json.contains("\"host\" : \"localhost:8080\""));
assertTrue(json.contains("\"basePath\" : \"/api\""));
- assertTrue(json.contains("\"/hello//bye\""));
+ assertTrue(json.contains("\"/hello/bye\""));
assertTrue(json.contains("\"summary\" : \"To update the greeting message\""));
- assertTrue(json.contains("\"/hello//bye/{name}\""));
- assertTrue(json.contains("\"/hello//hi/{name}\""));
+ assertTrue(json.contains("\"/hello/bye/{name}\""));
+ assertTrue(json.contains("\"/hello/hi/{name}\""));
context.stop();
}