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/18 17:43:47 UTC
[01/21] camel git commit: CAMEL-7800: camel-swagger-java - work in
progress
Repository: camel
Updated Branches:
refs/heads/master b10868b85 -> edd4140bf
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/b71650dc
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/b71650dc
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/b71650dc
Branch: refs/heads/master
Commit: b71650dc2aa0d7545bbefe96baa8a9352b56c184
Parents: e5c2ffb
Author: Claus Ibsen <da...@apache.org>
Authored: Thu Sep 17 16:05:22 2015 +0200
Committer: Claus Ibsen <da...@apache.org>
Committed: Fri Sep 18 16:16:11 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/b71650dc/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/b71650dc/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/b71650dc/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/b71650dc/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");
}
[09/21] 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/c76cbd14
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/c76cbd14
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/c76cbd14
Branch: refs/heads/master
Commit: c76cbd1465e2c73f80e67dbd84993b35655de2fb
Parents: 2a021a1
Author: Claus Ibsen <da...@apache.org>
Authored: Fri Sep 18 13:46:59 2015 +0200
Committer: Claus Ibsen <da...@apache.org>
Committed: Fri Sep 18 16:16:13 2015 +0200
----------------------------------------------------------------------
.../RestOperationResponseMsgDefinition.java | 35 ++++++-----
.../camel/component/rest/FromRestGetTest.java | 4 +-
components/camel-swagger-java/pom.xml | 61 ++++++++++++++------
.../apache/camel/swagger/RestSwaggerReader.java | 11 +++-
examples/camel-example-swagger-java/pom.xml | 4 --
.../src/main/resources/camel-config-xml.xml | 16 +++--
.../src/main/webapp/home.html | 14 ++---
7 files changed, 91 insertions(+), 54 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/c76cbd14/camel-core/src/main/java/org/apache/camel/model/rest/RestOperationResponseMsgDefinition.java
----------------------------------------------------------------------
diff --git a/camel-core/src/main/java/org/apache/camel/model/rest/RestOperationResponseMsgDefinition.java b/camel-core/src/main/java/org/apache/camel/model/rest/RestOperationResponseMsgDefinition.java
index ddd08bb..7705e96 100644
--- a/camel-core/src/main/java/org/apache/camel/model/rest/RestOperationResponseMsgDefinition.java
+++ b/camel-core/src/main/java/org/apache/camel/model/rest/RestOperationResponseMsgDefinition.java
@@ -28,8 +28,6 @@ import org.apache.camel.spi.Metadata;
* To specify the rest operation response messages using Swagger.
* <p/>
* This maps to the Swagger Response Message Object.
- * see com.wordnik.swagger.model.ResponseMessage
- * and https://github.com/swagger-api/swagger-spec/blob/master/versions/1.2.md#525-response-message-object.
*/
@Metadata(label = "rest")
@XmlRootElement(name = "responseMessage")
@@ -39,8 +37,9 @@ public class RestOperationResponseMsgDefinition {
@XmlTransient
private VerbDefinition verb;
- @XmlAttribute(required = true)
- private int code;
+ @XmlAttribute
+ @Metadata(defaultValue = "200")
+ private String code;
@XmlAttribute(required = true)
private String message;
@@ -56,14 +55,11 @@ public class RestOperationResponseMsgDefinition {
public RestOperationResponseMsgDefinition() {
}
- public int getCode() {
- return code != 0 ? code : 200;
+ public String getCode() {
+ return code != null ? code : "200";
}
- /**
- * Sets the Swagger Operation's ResponseMessage code
- */
- public void setCode(int code) {
+ public void setCode(String code) {
this.code = code;
}
@@ -71,9 +67,6 @@ public class RestOperationResponseMsgDefinition {
return responseModel != null ? responseModel : "";
}
- /**
- * Sets the Swagger Operation's ResponseMessage responseModel
- */
public void setResponseModel(String responseModel) {
this.responseModel = responseModel;
}
@@ -82,23 +75,29 @@ public class RestOperationResponseMsgDefinition {
return message != null ? message : "success";
}
- /**
- * Sets the Swagger Operation's ResponseMessage message
- */
public void setMessage(String message) {
this.message = message;
}
/**
- * The return code
+ * The response code such as a HTTP status code.
*/
public RestOperationResponseMsgDefinition code(int code) {
+ setCode("" + code);
+ return this;
+ }
+
+ /**
+ * The response code such as a HTTP status code. Can use <tt>general</tt>, or other words
+ * to indicate general error responses that do not map to a specific HTTP status code.
+ */
+ public RestOperationResponseMsgDefinition code(String code) {
setCode(code);
return this;
}
/**
- * The return message
+ * The response message (description)
*/
public RestOperationResponseMsgDefinition message(String msg) {
setMessage(msg);
http://git-wip-us.apache.org/repos/asf/camel/blob/c76cbd14/camel-core/src/test/java/org/apache/camel/component/rest/FromRestGetTest.java
----------------------------------------------------------------------
diff --git a/camel-core/src/test/java/org/apache/camel/component/rest/FromRestGetTest.java b/camel-core/src/test/java/org/apache/camel/component/rest/FromRestGetTest.java
index b82d9a0..3297ce0 100644
--- a/camel-core/src/test/java/org/apache/camel/component/rest/FromRestGetTest.java
+++ b/camel-core/src/test/java/org/apache/camel/component/rest/FromRestGetTest.java
@@ -79,7 +79,8 @@ public class FromRestGetTest extends ContextTestSupport {
assertEquals("acc1", rest.getVerbs().get(0).getParams().get(0).getAccess());
assertEquals("acc2", rest.getVerbs().get(0).getParams().get(1).getAccess());
- assertEquals(300, rest.getVerbs().get(0).getResponseMsgs().get(0).getCode());
+ assertEquals("300", rest.getVerbs().get(0).getResponseMsgs().get(0).getCode());
+ assertEquals("error", rest.getVerbs().get(0).getResponseMsgs().get(1).getCode());
assertEquals("test msg", rest.getVerbs().get(0).getResponseMsgs().get(0).getMessage());
assertEquals(Integer.class.getCanonicalName(), rest.getVerbs().get(0).getResponseMsgs().get(0).getResponseModel());
@@ -115,6 +116,7 @@ public class FromRestGetTest extends ContextTestSupport {
.defaultValue("b").allowMultiple(true).name("header_letter").required(false).access("acc2")
.endParam()
.responseMessage().code(300).message("test msg").responseModel(Integer.class).endResponseMessage()
+ .responseMessage().code("error").message("does not work").endResponseMessage()
.to("direct:bye")
.post().to("mock:update");
http://git-wip-us.apache.org/repos/asf/camel/blob/c76cbd14/components/camel-swagger-java/pom.xml
----------------------------------------------------------------------
diff --git a/components/camel-swagger-java/pom.xml b/components/camel-swagger-java/pom.xml
index 5e0177a..742a9e5 100644
--- a/components/camel-swagger-java/pom.xml
+++ b/components/camel-swagger-java/pom.xml
@@ -40,24 +40,66 @@
<artifactId>camel-core</artifactId>
</dependency>
+ <!-- align to use versions from Camel BOM -->
+ <dependency>
+ <groupId>com.fasterxml.jackson.core</groupId>
+ <artifactId>jackson-annotations</artifactId>
+ <version>${jackson2-version}</version>
+ </dependency>
+ <dependency>
+ <groupId>com.fasterxml.jackson.core</groupId>
+ <artifactId>jackson-databind</artifactId>
+ <version>${jackson2-version}</version>
+ </dependency>
+ <dependency>
+ <groupId>com.fasterxml.jackson.datatype</groupId>
+ <artifactId>jackson-datatype-joda</artifactId>
+ <version>${jackson2-version}</version>
+ </dependency>
+ <dependency>
+ <groupId>com.fasterxml.jackson.dataformat</groupId>
+ <artifactId>jackson-dataformat-yaml</artifactId>
+ <version>${jackson2-version}</version>
+ </dependency>
+ <dependency>
+ <groupId>com.fasterxml.jackson.dataformat</groupId>
+ <artifactId>jackson-dataformat-xml</artifactId>
+ <version>${jackson2-version}</version>
+ </dependency>
+ <dependency>
+ <groupId>com.fasterxml.jackson.jaxrs</groupId>
+ <artifactId>jackson-jaxrs-json-provider</artifactId>
+ <version>${jackson2-version}</version>
+ </dependency>
+ <dependency>
+ <groupId>com.google.guava</groupId>
+ <artifactId>guava</artifactId>
+ <version>${google-guava-version}</version>
+ </dependency>
+ <dependency>
+ <groupId>org.apache.commons</groupId>
+ <artifactId>commons-lang3</artifactId>
+ <version>${commons-lang3-version}</version>
+ </dependency>
+
+ <!-- swagger -->
<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>
+ <!-- servlet api -->
<dependency>
<groupId>javax.servlet</groupId>
<artifactId>servlet-api</artifactId>
@@ -72,21 +114,6 @@
<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>
http://git-wip-us.apache.org/repos/asf/camel/blob/c76cbd14/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 a83c03d..8f12dfe 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
@@ -158,6 +158,7 @@ public class RestSwaggerReader {
parameter.setDescription(param.getDescription());
parameter.setRequired(param.getRequired());
+ // set type on parameter
if (parameter instanceof SerializableParameter) {
SerializableParameter sp = (SerializableParameter) parameter;
@@ -166,6 +167,7 @@ public class RestSwaggerReader {
}
}
+ // set schema on body parameter
if (parameter instanceof BodyParameter) {
BodyParameter bp = (BodyParameter) parameter;
@@ -181,6 +183,7 @@ public class RestSwaggerReader {
}
}
+ // if we have an out type then set that as response message
if (verb.getOutType() != null) {
Response response = new Response();
Property prop = modelTypeAsProperty(verb.getOutType(), swagger);
@@ -189,13 +192,17 @@ public class RestSwaggerReader {
op.addResponse("200", response);
}
+ // enrich with configured response messages from the rest-dsl
for (RestOperationResponseMsgDefinition msg : verb.getResponseMsgs()) {
- Response response = op.getResponses().get("" + msg.getCode());
+ Response response = null;
+ if (op.getResponses() != null) {
+ response = op.getResponses().get(msg.getCode());
+ }
if (response == null) {
response = new Response();
}
response.setDescription(msg.getMessage());
- op.addResponse("" + msg.getCode(), response);
+ op.addResponse(msg.getCode(), response);
}
// add path
http://git-wip-us.apache.org/repos/asf/camel/blob/c76cbd14/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 09b0ba7..7552a65 100755
--- a/examples/camel-example-swagger-java/pom.xml
+++ b/examples/camel-example-swagger-java/pom.xml
@@ -53,10 +53,6 @@
<groupId>org.apache.camel</groupId>
<artifactId>camel-servlet</artifactId>
</dependency>
- <dependency>
- <groupId>org.apache.camel</groupId>
- <artifactId>camel-metrics</artifactId>
- </dependency>
<!-- swagger api -->
<dependency>
http://git-wip-us.apache.org/repos/asf/camel/blob/c76cbd14/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
index 8ec9b0b..be888b4 100755
--- 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
@@ -23,9 +23,6 @@
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"/>
@@ -50,7 +47,17 @@
<get uri="/{id}" outType="org.apache.camel.example.rest.User">
<description>Find user by id</description>
<param name="id" type="path" description="The id of the user to get" dataType="integer"/>
- <to uri="bean:userService?method=getUser(${header.id})"/>
+ <responseMessage message="The user that was found"/>
+ <responseMessage code="404" message="User not found"/>
+ <route>
+ <to uri="bean:userService?method=getUser(${header.id})"/>
+ <filter>
+ <simple>${body} == null</simple>
+ <setHeader headerName="Exchange.HTTP_RESPONSE_CODE">
+ <constant>404</constant>
+ </setHeader>
+ </filter>
+ </route>
</get>
<!-- this is a rest PUT to create/update an user -->
@@ -63,6 +70,7 @@
<!-- this is a rest GET to find all users -->
<get uri="/findAll" outType="org.apache.camel.example.rest.User[]">
<description>Find all users</description>
+ <responseMessage message="All the users"/>
<to uri="bean:userService?method=listUsers"/>
</get>
</rest>
http://git-wip-us.apache.org/repos/asf/camel/blob/c76cbd14/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
index b9c4e2a..71e50c8 100644
--- a/examples/camel-example-swagger-java/src/main/webapp/home.html
+++ b/examples/camel-example-swagger-java/src/main/webapp/home.html
@@ -18,7 +18,7 @@
<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>
+ <title>Apache Camel Swagger Java Example</title>
<link rel="stylesheet" href="css/foundation.min.css"/>
<script src="js/vendor/modernizr.js"></script>
</head>
@@ -26,23 +26,21 @@
<body>
<div class="row">
<div class="large-12 columns">
- <h2>Apache Camel Example using Servlet REST & Web Container</h2>
+ <h2>Apache Camel Example using Swagger Java</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
+ This example shows how to use Servlet REST to define REST endpoints in Camel routes using the Rest DSL,
+ and using camel-swagger-java to expose the REST service APIs.
<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
+ This example is implemented in XML DSL.
<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.
+ The XML DSL the routes are define in XML code, in the <tt>src/main/resources/camel-config-xml.xml</tt> file.
<p/>
There is a <i>user</i> REST service that supports the following operations
[21/21] 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/edd4140b
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/edd4140b
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/edd4140b
Branch: refs/heads/master
Commit: edd4140bf2a7387f860818d459a8a51306bdc456
Parents: 0596a0d
Author: Claus Ibsen <da...@apache.org>
Authored: Fri Sep 18 17:45:00 2015 +0200
Committer: Claus Ibsen <da...@apache.org>
Committed: Fri Sep 18 17:45:00 2015 +0200
----------------------------------------------------------------------
.../org/apache/camel/component/swagger/RestSwaggerReader.scala | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/edd4140b/components/camel-swagger/src/main/scala/org/apache/camel/component/swagger/RestSwaggerReader.scala
----------------------------------------------------------------------
diff --git a/components/camel-swagger/src/main/scala/org/apache/camel/component/swagger/RestSwaggerReader.scala b/components/camel-swagger/src/main/scala/org/apache/camel/component/swagger/RestSwaggerReader.scala
index 39d9b2b..aae45c9 100644
--- a/components/camel-swagger/src/main/scala/org/apache/camel/component/swagger/RestSwaggerReader.scala
+++ b/components/camel-swagger/src/main/scala/org/apache/camel/component/swagger/RestSwaggerReader.scala
@@ -178,7 +178,7 @@ class RestSwaggerReader {
for (param:RestOperationResponseMsgDefinition <- verb.getResponseMsgs.asScala) {
responseMsgs += ResponseMessage(
- param.getCode,
+ param.getCode.asInstanceOf[Integer],
param.getMessage,
Option( param.getResponseModel )
)
[15/21] 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/2047a204
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/2047a204
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/2047a204
Branch: refs/heads/master
Commit: 2047a2043f8a0ab12a3a4de6c94bfb304ad9c179
Parents: d54f0bc
Author: Claus Ibsen <da...@apache.org>
Authored: Fri Sep 18 15:27:53 2015 +0200
Committer: Claus Ibsen <da...@apache.org>
Committed: Fri Sep 18 16:16:14 2015 +0200
----------------------------------------------------------------------
.../RestSwaggerApiDeclarationServlet.java | 28 ++++++------------
.../apache/camel/swagger/RestSwaggerReader.java | 30 +++++++++++++++-----
.../swagger/RestSwaggerReaderModelTest.java | 5 +---
.../camel/swagger/RestSwaggerReaderTest.java | 6 +---
.../src/main/resources/camel-config-xml.xml | 15 ++++++++++
5 files changed, 49 insertions(+), 35 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/2047a204/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 68d621b..dc1b938 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
@@ -29,6 +29,7 @@ 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.core.filter.SpecFilter;
import io.swagger.jaxrs.config.BeanConfig;
import io.swagger.models.Contact;
import io.swagger.models.Info;
@@ -144,21 +145,14 @@ public abstract class RestSwaggerApiDeclarationServlet extends HttpServlet {
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);
- }
+ renderResourceListing(request, response, contextId, route);
}
} catch (Exception e) {
LOG.warn("Error rendering swagger due " + e.getMessage(), e);
}
}
- private void renderResourceListing(HttpServletRequest request, HttpServletResponse response, String contextId) throws Exception {
+ private void renderResourceListing(HttpServletRequest request, HttpServletResponse response, String contextId, String route) throws Exception {
LOG.trace("renderResourceListing");
if (cors) {
@@ -169,17 +163,13 @@ public abstract class RestSwaggerApiDeclarationServlet extends HttpServlet {
List<RestDefinition> rests = getRestDefinitions(contextId);
if (rests != null) {
+ // read the rest-dsl into swagger model
+ Swagger swagger = reader.read(rests, route, swaggerConfig, new DefaultClassResolver());
- // TODO: combine the rests
-
- for (RestDefinition rest : rests) {
- Swagger swagger = reader.read(rest, swaggerConfig, new DefaultClassResolver());
-
- ObjectMapper mapper = new ObjectMapper();
- mapper.enable(SerializationFeature.INDENT_OUTPUT);
- mapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);
- mapper.writeValue(response.getOutputStream(), swagger);
- }
+ ObjectMapper mapper = new ObjectMapper();
+ mapper.enable(SerializationFeature.INDENT_OUTPUT);
+ mapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);
+ mapper.writeValue(response.getOutputStream(), swagger);
} else {
response.setStatus(204);
}
http://git-wip-us.apache.org/repos/asf/camel/blob/2047a204/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 1ad8c1f..fcfb057 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
@@ -50,6 +50,7 @@ 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.spi.ClassResolver;
+import org.apache.camel.util.ObjectHelper;
/**
* A Camel REST-DSL swagger reader that parse the rest-dsl into a swagger model representation.
@@ -57,16 +58,35 @@ import org.apache.camel.spi.ClassResolver;
public class RestSwaggerReader {
/**
- * Read the REST-DSL definition and parse that as a Swagger model representation
+ * Read the REST-DSL definition's and parse that as a Swagger model representation
*
- * @param rest the rest-dsl
+ * @param rests the rest-dsl
+ * @param route optional route path to filter the rest-dsl to only include from the chose route
* @param config the swagger configuration
* @param classResolver class resolver to use
* @return the swagger model
*/
- public Swagger read(RestDefinition rest, BeanConfig config, ClassResolver classResolver) {
+ public Swagger read(List<RestDefinition> rests, String route, BeanConfig config, ClassResolver classResolver) {
Swagger swagger = new Swagger();
+ for (RestDefinition rest : rests) {
+
+ if (ObjectHelper.isNotEmpty(route) && !route.equals("/")) {
+ // filter by route
+ if (!rest.getPath().equals(route)) {
+ continue;
+ }
+ }
+
+ parse(swagger, rest, classResolver);
+ }
+
+ // configure before returning
+ swagger = config.configure(swagger);
+ return swagger;
+ }
+
+ private void parse(Swagger swagger, RestDefinition rest, ClassResolver classResolver) {
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());
@@ -207,10 +227,6 @@ public class RestSwaggerReader {
// add path
swagger.path(opPath, path);
}
-
- // configure before returning
- swagger = config.configure(swagger);
- return swagger;
}
private Model asModel(String typeName, Swagger swagger) {
http://git-wip-us.apache.org/repos/asf/camel/blob/2047a204/components/camel-swagger-java/src/test/java/org/apache/camel/swagger/RestSwaggerReaderModelTest.java
----------------------------------------------------------------------
diff --git a/components/camel-swagger-java/src/test/java/org/apache/camel/swagger/RestSwaggerReaderModelTest.java b/components/camel-swagger-java/src/test/java/org/apache/camel/swagger/RestSwaggerReaderModelTest.java
index 301421f..4d26438 100644
--- a/components/camel-swagger-java/src/test/java/org/apache/camel/swagger/RestSwaggerReaderModelTest.java
+++ b/components/camel-swagger-java/src/test/java/org/apache/camel/swagger/RestSwaggerReaderModelTest.java
@@ -65,9 +65,6 @@ public class RestSwaggerReaderModelTest extends CamelTestSupport {
@Test
public void testReaderRead() throws Exception {
- RestDefinition rest = context.getRestDefinitions().get(0);
- assertNotNull(rest);
-
BeanConfig config = new BeanConfig();
config.setHost("localhost:8080");
config.setSchemes(new String[]{"http"});
@@ -77,7 +74,7 @@ public class RestSwaggerReaderModelTest extends CamelTestSupport {
config.setLicenseUrl("http://www.apache.org/licenses/LICENSE-2.0.html");
RestSwaggerReader reader = new RestSwaggerReader();
- Swagger swagger = reader.read(rest, config, new DefaultClassResolver());
+ Swagger swagger = reader.read(context.getRestDefinitions(), null, config, new DefaultClassResolver());
assertNotNull(swagger);
ObjectMapper mapper = new ObjectMapper();
http://git-wip-us.apache.org/repos/asf/camel/blob/2047a204/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 b7c9de3..20becb4 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,7 +24,6 @@ import io.swagger.models.Swagger;
import org.apache.camel.builder.RouteBuilder;
import org.apache.camel.impl.DefaultClassResolver;
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;
@@ -60,16 +59,13 @@ public class RestSwaggerReaderTest extends CamelTestSupport {
@Test
public void testReaderRead() throws Exception {
- RestDefinition rest = context.getRestDefinitions().get(0);
- assertNotNull(rest);
-
BeanConfig config = new BeanConfig();
config.setHost("localhost:8080");
config.setSchemes(new String[]{"http"});
config.setBasePath("/api");
RestSwaggerReader reader = new RestSwaggerReader();
- Swagger swagger = reader.read(rest, config, new DefaultClassResolver());
+ Swagger swagger = reader.read(context.getRestDefinitions(), null, config, new DefaultClassResolver());
assertNotNull(swagger);
ObjectMapper mapper = new ObjectMapper();
http://git-wip-us.apache.org/repos/asf/camel/blob/2047a204/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
index be888b4..ecdeed7 100755
--- 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
@@ -75,6 +75,21 @@
</get>
</rest>
+ <!-- defines the rest services using the context-path /echo -->
+ <rest path="/echo" consumes="application/text" produces="application/text">
+ <description>Echo rest service</description>
+
+ <get uri="/ping">
+ <description>A ping service</description>
+ <route>
+ <transform>
+ <constant>pong</constant>
+ </transform>
+ </route>
+ </get>
+
+ </rest>
+
</camelContext>
</beans>
\ No newline at end of file
[05/21] 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/2ce6072c
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/2ce6072c
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/2ce6072c
Branch: refs/heads/master
Commit: 2ce6072c4c0e2a69c99edd002bf1273605e2c1bb
Parents: 83261fe
Author: Claus Ibsen <da...@apache.org>
Authored: Thu Sep 17 16:58:42 2015 +0200
Committer: Claus Ibsen <da...@apache.org>
Committed: Fri Sep 18 16:16:12 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/2ce6072c/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/2ce6072c/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();
}
[13/21] 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/d84e8805
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/d84e8805
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/d84e8805
Branch: refs/heads/master
Commit: d84e8805d140f771ca01eed21b25d53839ac951d
Parents: 2047a20
Author: Claus Ibsen <da...@apache.org>
Authored: Fri Sep 18 15:37:03 2015 +0200
Committer: Claus Ibsen <da...@apache.org>
Committed: Fri Sep 18 16:16:14 2015 +0200
----------------------------------------------------------------------
.../org/apache/camel/swagger/RestSwaggerReader.java | 13 +++++++++++++
1 file changed, 13 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/d84e8805/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 fcfb057..ae9c46f 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,6 +33,7 @@ import io.swagger.models.Path;
import io.swagger.models.RefModel;
import io.swagger.models.Response;
import io.swagger.models.Swagger;
+import io.swagger.models.Tag;
import io.swagger.models.parameters.BodyParameter;
import io.swagger.models.parameters.FormParameter;
import io.swagger.models.parameters.HeaderParameter;
@@ -50,6 +51,7 @@ 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.spi.ClassResolver;
+import org.apache.camel.util.FileUtil;
import org.apache.camel.util.ObjectHelper;
/**
@@ -91,6 +93,15 @@ public class RestSwaggerReader {
// must sort the verbs by uri so we group them together when an uri has multiple operations
Collections.sort(verbs, new VerbOrdering());
+ String pathAsTag = FileUtil.stripLeadingSeparator(rest.getPath());
+ String summary = rest.getDescriptionText();
+
+ // add rest as tag
+ Tag tag = new Tag();
+ tag.description(summary);
+ tag.name(pathAsTag);
+ swagger.addTag(tag);
+
// gather all types in use
Set<String> types = new LinkedHashSet<>();
for (VerbDefinition verb : verbs) {
@@ -129,6 +140,8 @@ public class RestSwaggerReader {
String opPath = SwaggerHelper.buildUrl(basePath, verb.getUri());
Operation op = new Operation();
+ // group in the same tag
+ op.addTag(pathAsTag);
Path path = swagger.getPath(opPath);
if (path == null) {
[20/21] 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/0596a0dc
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/0596a0dc
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/0596a0dc
Branch: refs/heads/master
Commit: 0596a0dc5e9485033534945922ef9015cc170e9c
Parents: 560baa2
Author: Claus Ibsen <da...@apache.org>
Authored: Fri Sep 18 16:17:04 2015 +0200
Committer: Claus Ibsen <da...@apache.org>
Committed: Fri Sep 18 16:17:04 2015 +0200
----------------------------------------------------------------------
apache-camel/src/main/descriptors/common-bin.xml | 1 +
1 file changed, 1 insertion(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/0596a0dc/apache-camel/src/main/descriptors/common-bin.xml
----------------------------------------------------------------------
diff --git a/apache-camel/src/main/descriptors/common-bin.xml b/apache-camel/src/main/descriptors/common-bin.xml
index 87a8fd4..089f694 100644
--- a/apache-camel/src/main/descriptors/common-bin.xml
+++ b/apache-camel/src/main/descriptors/common-bin.xml
@@ -204,6 +204,7 @@
<include>org.apache.camel:camel-stringtemplate</include>
<include>org.apache.camel:camel-syslog</include>
<include>org.apache.camel:camel-swagger</include>
+ <include>org.apache.camel:camel-swagger-java</include>
<include>org.apache.camel:camel-tagsoup</include>
<include>org.apache.camel:camel-test</include>
<include>org.apache.camel:camel-test-blueprint</include>
[19/21] 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/560baa22
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/560baa22
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/560baa22
Branch: refs/heads/master
Commit: 560baa223eb268795f4d4a26b2df51287ab3d667
Parents: e2f5c9f
Author: Claus Ibsen <da...@apache.org>
Authored: Fri Sep 18 16:13:38 2015 +0200
Committer: Claus Ibsen <da...@apache.org>
Committed: Fri Sep 18 16:16:15 2015 +0200
----------------------------------------------------------------------
examples/camel-example-swagger-java/pom.xml | 3 +++
.../src/main/resources/camel-config-xml.xml | 2 +-
2 files changed, 4 insertions(+), 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/560baa22/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 7552a65..04f690d 100755
--- a/examples/camel-example-swagger-java/pom.xml
+++ b/examples/camel-example-swagger-java/pom.xml
@@ -195,6 +195,9 @@
<artifactId>jetty-maven-plugin</artifactId>
<version>${jetty9-version}</version>
<configuration>
+ <httpConnector>
+ <port>8080</port>
+ </httpConnector>
<webAppSourceDirectory>target/classes</webAppSourceDirectory>
<webApp>
<contextPath>/${project.artifactId}</contextPath>
http://git-wip-us.apache.org/repos/asf/camel/blob/560baa22/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
index ecdeed7..56149e5 100755
--- 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
@@ -35,7 +35,7 @@
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">
+ <restConfiguration component="servlet" bindingMode="json" contextPath="camel-example-swagger-java/rest" port="8080">
<dataFormatProperty key="prettyPrint" value="true"/>
</restConfiguration>
[10/21] 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/1817a41e
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/1817a41e
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/1817a41e
Branch: refs/heads/master
Commit: 1817a41ea9165453bd8904498a4ed5c2a20e81a0
Parents: bf36f61
Author: Claus Ibsen <da...@apache.org>
Authored: Fri Sep 18 12:23:55 2015 +0200
Committer: Claus Ibsen <da...@apache.org>
Committed: Fri Sep 18 16:16:13 2015 +0200
----------------------------------------------------------------------
.../apache/camel/swagger/RestSwaggerReader.java | 85 ++++++++++++++------
.../src/test/resources/log4j.properties | 2 +-
2 files changed, 61 insertions(+), 26 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/1817a41e/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 e664529..90f5956 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
@@ -30,6 +30,7 @@ import io.swagger.models.Model;
import io.swagger.models.ModelImpl;
import io.swagger.models.Operation;
import io.swagger.models.Path;
+import io.swagger.models.RefModel;
import io.swagger.models.Response;
import io.swagger.models.Swagger;
import io.swagger.models.parameters.BodyParameter;
@@ -40,6 +41,7 @@ import io.swagger.models.parameters.PathParameter;
import io.swagger.models.parameters.QueryParameter;
import io.swagger.models.parameters.SerializableParameter;
import io.swagger.models.properties.ArrayProperty;
+import io.swagger.models.properties.Property;
import io.swagger.models.properties.RefProperty;
import io.swagger.models.properties.StringProperty;
import org.apache.camel.model.rest.RestDefinition;
@@ -159,15 +161,18 @@ public class RestSwaggerReader {
if (parameter instanceof SerializableParameter) {
SerializableParameter sp = (SerializableParameter) parameter;
- // TODO: like response object with type refer to model
if (param.getDataType() != null) {
sp.setType(param.getDataType());
- } else if (verb.getType() != null) {
- boolean array = verb.getType().endsWith("[]");
- if (array) {
- sp.setType("array");
- } else {
- sp.setType(verb.getType());
+ }
+ }
+
+ if (parameter instanceof BodyParameter) {
+ BodyParameter bp = (BodyParameter) parameter;
+
+ if (verb.getType() != null) {
+ String ref = modelTypeAsRef(verb.getType(), swagger);
+ if (ref != null) {
+ bp.setSchema(new RefModel(ref));
}
}
}
@@ -178,23 +183,8 @@ public class RestSwaggerReader {
if (verb.getOutType() != null) {
Response response = new Response();
- boolean array = verb.getOutType().endsWith("[]");
- String type = array ? verb.getOutType().substring(0, verb.getOutType().length() - 2) : verb.getOutType();
- // lookup in models to use key instead of FQN
-
- for (Model model : swagger.getDefinitions().values()) {
- StringProperty modelType = (StringProperty) model.getVendorExtensions().get("x-className");
- if (modelType != null && type.equals(modelType.getFormat())) {
- type = ((ModelImpl) model).getName();
- break;
- }
- }
-
- if (array) {
- response.setSchema(new ArrayProperty(new RefProperty(type)));
- } else {
- response.setSchema(new RefProperty(type));
- }
+ Property prop = modelTypeAsProperty(verb.getOutType(), swagger);
+ response.setSchema(prop);
response.setDescription("Output type");
op.addResponse("200", response);
}
@@ -207,12 +197,57 @@ public class RestSwaggerReader {
// add path
swagger.path(opPath, path);
-
}
return swagger;
}
+ private Model asModel(String typeName, Swagger swagger) {
+ boolean array = typeName.endsWith("[]");
+ if (array) {
+ typeName = typeName.substring(0, typeName.length() - 2);
+ }
+
+ for (Model model : swagger.getDefinitions().values()) {
+ StringProperty modelType = (StringProperty) model.getVendorExtensions().get("x-className");
+ if (modelType != null && typeName.equals(modelType.getFormat())) {
+ return model;
+ }
+ }
+ return null;
+ }
+
+ private String modelTypeAsRef(String typeName, Swagger swagger) {
+ boolean array = typeName.endsWith("[]");
+ if (array) {
+ typeName = typeName.substring(0, typeName.length() - 2);
+ }
+
+ Model model = asModel(typeName, swagger);
+ if (model != null) {
+ typeName = ((ModelImpl) model).getName();
+ return typeName;
+ }
+
+ return null;
+ }
+
+ private Property modelTypeAsProperty(String typeName, Swagger swagger) {
+ boolean array = typeName.endsWith("[]");
+ if (array) {
+ typeName = typeName.substring(0, typeName.length() - 2);
+ }
+
+ String ref = modelTypeAsRef(typeName, swagger);
+
+ Property prop = ref != null ? new RefProperty(ref) : new StringProperty(typeName);
+ if (array) {
+ return new ArrayProperty(prop);
+ } else {
+ return prop;
+ }
+ }
+
/**
* If the class is annotated with swagger annotations its parsed into a Swagger model representation
* which is added to swagger
http://git-wip-us.apache.org/repos/asf/camel/blob/1817a41e/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 6e040b0..e5d9b29 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.swagger=TRACE
[03/21] 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/14083335
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/14083335
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/14083335
Branch: refs/heads/master
Commit: 1408333526d7d5c8d66879a7ff6425be702439f3
Parents: 1d5b0da
Author: Claus Ibsen <da...@apache.org>
Authored: Thu Sep 17 15:02:33 2015 +0200
Committer: Claus Ibsen <da...@apache.org>
Committed: Fri Sep 18 16:16:11 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/14083335/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/14083335/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/14083335/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/14083335/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
[02/21] 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/e5c2ffb0
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/e5c2ffb0
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/e5c2ffb0
Branch: refs/heads/master
Commit: e5c2ffb046b123597d227e72b0316a90868bbf8a
Parents: 1408333
Author: Claus Ibsen <da...@apache.org>
Authored: Thu Sep 17 15:51:59 2015 +0200
Committer: Claus Ibsen <da...@apache.org>
Committed: Fri Sep 18 16:16:11 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/e5c2ffb0/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/e5c2ffb0/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/e5c2ffb0/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
[08/21] 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/5abb26a1
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/5abb26a1
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/5abb26a1
Branch: refs/heads/master
Commit: 5abb26a16017837ba48896293238384719c06608
Parents: b71650d
Author: Claus Ibsen <da...@apache.org>
Authored: Thu Sep 17 16:35:23 2015 +0200
Committer: Claus Ibsen <da...@apache.org>
Committed: Fri Sep 18 16:16:12 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/5abb26a1/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/5abb26a1/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/5abb26a1/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/5abb26a1/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/5abb26a1/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/5abb26a1/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/5abb26a1/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/5abb26a1/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/5abb26a1/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/5abb26a1/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/5abb26a1/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/5abb26a1/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/5abb26a1/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/5abb26a1/parent/pom.xml
----------------------------------------------------------------------
diff --git a/parent/pom.xml b/parent/pom.xml
index 18f6f89..dc3f159 100644
--- a/parent/pom.xml
+++ b/parent/pom.xml
@@ -1524,6 +1524,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>
[16/21] 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/83341f2d
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/83341f2d
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/83341f2d
Branch: refs/heads/master
Commit: 83341f2d3cac9ae3a8a454f34c9780a61d413bf3
Parents: 11d97a6
Author: Claus Ibsen <da...@apache.org>
Authored: Fri Sep 18 15:47:30 2015 +0200
Committer: Claus Ibsen <da...@apache.org>
Committed: Fri Sep 18 16:16:14 2015 +0200
----------------------------------------------------------------------
.../swagger/DefaultCamelSwaggerServlet.java | 7 +-
.../swagger/RestSwaggerAbstractServlet.java | 241 +++++++++++++++++++
.../RestSwaggerApiDeclarationServlet.java | 239 ------------------
3 files changed, 247 insertions(+), 240 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/83341f2d/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
index 2a68868..b3c73e6 100644
--- 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
@@ -28,7 +28,12 @@ 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 {
+/**
+ * The default Camel swagger servlet to use when exposing the APIs of the rest-dsl using swagger.
+ * <p/>
+ * This requires Camel version 2.15 or better at runtime (and JMX to be enabled).
+ */
+public class DefaultCamelSwaggerServlet extends RestSwaggerAbstractServlet {
@Override
public List<RestDefinition> getRestDefinitions(String camelId) throws Exception {
http://git-wip-us.apache.org/repos/asf/camel/blob/83341f2d/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/RestSwaggerAbstractServlet.java
----------------------------------------------------------------------
diff --git a/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/RestSwaggerAbstractServlet.java b/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/RestSwaggerAbstractServlet.java
new file mode 100644
index 0000000..a0a1a76
--- /dev/null
+++ b/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/RestSwaggerAbstractServlet.java
@@ -0,0 +1,241 @@
+/**
+ * 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 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.Contact;
+import io.swagger.models.Info;
+import io.swagger.models.License;
+import io.swagger.models.Swagger;
+import org.apache.camel.impl.DefaultClassResolver;
+import org.apache.camel.model.rest.RestDefinition;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import static org.apache.camel.swagger.SwaggerHelper.buildUrl;
+
+/**
+ * Base class for rest-dsl swagger integration to use a servlet to service the swagger api.
+ */
+public abstract class RestSwaggerAbstractServlet extends HttpServlet {
+
+ private Logger LOG = LoggerFactory.getLogger(RestSwaggerAbstractServlet.class);
+
+ 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("host");
+ if (s != null) {
+ swaggerConfig.setHost(s);
+ }
+ s = config.getInitParameter("cors");
+ if (s != null) {
+ cors = "true".equalsIgnoreCase(s);
+ }
+ s = config.getInitParameter("schemas");
+ if (s != null) {
+ String[] schemas = s.split(",");
+ swaggerConfig.setSchemes(schemas);
+ } else {
+ // assume http by default
+ swaggerConfig.setSchemes(new String[]{"http"});
+ }
+
+ String version = config.getInitParameter("api.version");
+ String title = config.getInitParameter("api.title");
+ String description = config.getInitParameter("api.description");
+ String termsOfService = config.getInitParameter("api.termsOfService");
+ String licenseName = config.getInitParameter("api.license.name");
+ String licenseUrl = config.getInitParameter("api.license.url");
+ String contactName = config.getInitParameter("api.contact.name");
+ String contactUrl = config.getInitParameter("api.contact.url");
+ String contactEmail = config.getInitParameter("api.contact.email");
+
+ Info info = new Info();
+ info.setVersion(version);
+ info.setTitle(title);
+ info.setDescription(description);
+ info.setTermsOfService(termsOfService);
+
+ if (licenseName != null || licenseUrl != null) {
+ License license = new License();
+ license.setName(licenseName);
+ license.setUrl(licenseUrl);
+ info.setLicense(license);
+ }
+
+ if (contactName != null || contactUrl != null || contactEmail != null) {
+ Contact contact = new Contact();
+ contact.setName(contactName);
+ contact.setUrl(contactUrl);
+ contact.setEmail(contactEmail);
+ info.setContact(contact);
+ }
+
+ swaggerConfig.setInfo(info);
+ }
+
+ 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());
+ }
+
+ renderResourceListing(request, response, contextId, route);
+ }
+ } catch (Exception e) {
+ LOG.warn("Error rendering swagger due " + e.getMessage(), e);
+ }
+ }
+
+ private void renderResourceListing(HttpServletRequest request, HttpServletResponse response, String contextId, String route) 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) {
+ // read the rest-dsl into swagger model
+ Swagger swagger = reader.read(rests, route, swaggerConfig, new DefaultClassResolver());
+
+ 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")) {
+ // 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);
+ swaggerConfig.setHost(url.getHost());
+
+ if (url.getPort() != 80 && url.getPort() != -1) {
+ swaggerConfig.setHost(url.getHost() + ":" + url.getPort());
+ } else {
+ swaggerConfig.setHost(url.getHost());
+ }
+ swaggerConfig.setBasePath(buildUrl(path, 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/83341f2d/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
deleted file mode 100644
index dc1b938..0000000
--- a/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/RestSwaggerApiDeclarationServlet.java
+++ /dev/null
@@ -1,239 +0,0 @@
-/**
- * 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 com.fasterxml.jackson.annotation.JsonInclude;
-import com.fasterxml.jackson.databind.ObjectMapper;
-import com.fasterxml.jackson.databind.SerializationFeature;
-import io.swagger.core.filter.SpecFilter;
-import io.swagger.jaxrs.config.BeanConfig;
-import io.swagger.models.Contact;
-import io.swagger.models.Info;
-import io.swagger.models.License;
-import io.swagger.models.Swagger;
-import org.apache.camel.impl.DefaultClassResolver;
-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);
-
- 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("host");
- if (s != null) {
- swaggerConfig.setHost(s);
- }
- s = config.getInitParameter("cors");
- if (s != null) {
- cors = "true".equalsIgnoreCase(s);
- }
- s = config.getInitParameter("schemas");
- if (s != null) {
- String[] schemas = s.split(",");
- swaggerConfig.setSchemes(schemas);
- } else {
- // assume http by default
- swaggerConfig.setSchemes(new String[]{"http"});
- }
-
- String version = config.getInitParameter("api.version");
- String title = config.getInitParameter("api.title");
- String description = config.getInitParameter("api.description");
- String termsOfService = config.getInitParameter("api.termsOfService");
- String licenseName = config.getInitParameter("api.license.name");
- String licenseUrl = config.getInitParameter("api.license.url");
- String contactName = config.getInitParameter("api.contact.name");
- String contactUrl = config.getInitParameter("api.contact.url");
- String contactEmail = config.getInitParameter("api.contact.email");
-
- Info info = new Info();
- info.setVersion(version);
- info.setTitle(title);
- info.setDescription(description);
- info.setTermsOfService(termsOfService);
-
- if (licenseName != null || licenseUrl != null) {
- License license = new License();
- license.setName(licenseName);
- license.setUrl(licenseUrl);
- info.setLicense(license);
- }
-
- if (contactName != null || contactUrl != null || contactEmail != null) {
- Contact contact = new Contact();
- contact.setName(contactName);
- contact.setUrl(contactUrl);
- contact.setEmail(contactEmail);
- info.setContact(contact);
- }
-
- swaggerConfig.setInfo(info);
- }
-
- 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());
- }
-
- renderResourceListing(request, response, contextId, route);
- }
- } catch (Exception e) {
- LOG.warn("Error rendering swagger due " + e.getMessage(), e);
- }
- }
-
- private void renderResourceListing(HttpServletRequest request, HttpServletResponse response, String contextId, String route) 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) {
- // read the rest-dsl into swagger model
- Swagger swagger = reader.read(rests, route, swaggerConfig, new DefaultClassResolver());
-
- 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")) {
- // 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);
- swaggerConfig.setHost(url.getHost());
-
- if (url.getPort() != 80 && url.getPort() != -1) {
- swaggerConfig.setHost(url.getHost() + ":" + url.getPort());
- } else {
- swaggerConfig.setHost(url.getHost());
- }
- swaggerConfig.setBasePath(buildUrl(path, 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]");
- }
-
-}
[07/21] 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/83261fe6
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/83261fe6
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/83261fe6
Branch: refs/heads/master
Commit: 83261fe6c102279051f1c7b605825fc0f037ab98
Parents: 5abb26a
Author: Claus Ibsen <da...@apache.org>
Authored: Thu Sep 17 16:36:34 2015 +0200
Committer: Claus Ibsen <da...@apache.org>
Committed: Fri Sep 18 16:16:12 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/83261fe6/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/83261fe6/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/83261fe6/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/83261fe6/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>
[06/21] 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/0fd7e668
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/0fd7e668
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/0fd7e668
Branch: refs/heads/master
Commit: 0fd7e668a2a7861846b336f26b3156fcc5aa92ab
Parents: 2ce6072
Author: Claus Ibsen <da...@apache.org>
Authored: Thu Sep 17 17:16:50 2015 +0200
Committer: Claus Ibsen <da...@apache.org>
Committed: Fri Sep 18 16:16:12 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/0fd7e668/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/0fd7e668/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/0fd7e668/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;
+ }
+ }
+}
[14/21] 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/11d97a6d
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/11d97a6d
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/11d97a6d
Branch: refs/heads/master
Commit: 11d97a6d29c6a23d705d9fc7bd80247f852479f8
Parents: d84e880
Author: Claus Ibsen <da...@apache.org>
Authored: Fri Sep 18 15:42:57 2015 +0200
Committer: Claus Ibsen <da...@apache.org>
Committed: Fri Sep 18 16:16:14 2015 +0200
----------------------------------------------------------------------
.../apache/camel/model/rest/RestDefinition.java | 22 ++++++++++++++++++++
.../apache/camel/swagger/RestSwaggerReader.java | 3 ++-
.../swagger/RestSwaggerReaderModelTest.java | 2 +-
3 files changed, 25 insertions(+), 2 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/11d97a6d/camel-core/src/main/java/org/apache/camel/model/rest/RestDefinition.java
----------------------------------------------------------------------
diff --git a/camel-core/src/main/java/org/apache/camel/model/rest/RestDefinition.java b/camel-core/src/main/java/org/apache/camel/model/rest/RestDefinition.java
index 4c5c044..9e1a34d 100644
--- a/camel-core/src/main/java/org/apache/camel/model/rest/RestDefinition.java
+++ b/camel-core/src/main/java/org/apache/camel/model/rest/RestDefinition.java
@@ -52,6 +52,9 @@ public class RestDefinition extends OptionalIdentifiedDefinition<RestDefinition>
private String path;
@XmlAttribute
+ private String tag;
+
+ @XmlAttribute
private String consumes;
@XmlAttribute
@@ -85,6 +88,17 @@ public class RestDefinition extends OptionalIdentifiedDefinition<RestDefinition>
this.path = path;
}
+ public String getTag() {
+ return tag;
+ }
+
+ /**
+ * To configure a special tag for the operations within this rest definition.
+ */
+ public void setTag(String tag) {
+ this.tag = tag;
+ }
+
public String getConsumes() {
return consumes;
}
@@ -173,6 +187,14 @@ public class RestDefinition extends OptionalIdentifiedDefinition<RestDefinition>
return this;
}
+ /**
+ * To set the tag to use of this REST service
+ */
+ public RestDefinition tag(String tag) {
+ setTag(tag);
+ return this;
+ }
+
public RestDefinition get() {
return addVerb("get", null);
}
http://git-wip-us.apache.org/repos/asf/camel/blob/11d97a6d/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 ae9c46f..d5eac90 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
@@ -93,7 +93,8 @@ public class RestSwaggerReader {
// must sort the verbs by uri so we group them together when an uri has multiple operations
Collections.sort(verbs, new VerbOrdering());
- String pathAsTag = FileUtil.stripLeadingSeparator(rest.getPath());
+ // we need to group the operations within the same tag, so use the path as default if not configured
+ String pathAsTag = rest.getTag() != null ? rest.getTag() : FileUtil.stripLeadingSeparator(rest.getPath());
String summary = rest.getDescriptionText();
// add rest as tag
http://git-wip-us.apache.org/repos/asf/camel/blob/11d97a6d/components/camel-swagger-java/src/test/java/org/apache/camel/swagger/RestSwaggerReaderModelTest.java
----------------------------------------------------------------------
diff --git a/components/camel-swagger-java/src/test/java/org/apache/camel/swagger/RestSwaggerReaderModelTest.java b/components/camel-swagger-java/src/test/java/org/apache/camel/swagger/RestSwaggerReaderModelTest.java
index 4d26438..d6293f5 100644
--- a/components/camel-swagger-java/src/test/java/org/apache/camel/swagger/RestSwaggerReaderModelTest.java
+++ b/components/camel-swagger-java/src/test/java/org/apache/camel/swagger/RestSwaggerReaderModelTest.java
@@ -44,7 +44,7 @@ public class RestSwaggerReaderModelTest extends CamelTestSupport {
@Override
public void configure() throws Exception {
// this user REST service is json only
- rest("/user").description("User rest service")
+ rest("/user").tag("dude").description("User rest service")
.consumes("application/json").produces("application/json")
.get("/{id}").description("Find user by id").outType(User.class)
[12/21] 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/2a021a19
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/2a021a19
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/2a021a19
Branch: refs/heads/master
Commit: 2a021a1968be2780d3fa0bfc980943a7fa6a0ef5
Parents: 1817a41
Author: Claus Ibsen <da...@apache.org>
Authored: Fri Sep 18 12:44:44 2015 +0200
Committer: Claus Ibsen <da...@apache.org>
Committed: Fri Sep 18 16:16:13 2015 +0200
----------------------------------------------------------------------
.../main/java/org/apache/camel/swagger/RestSwaggerReader.java | 5 ++++-
.../org/apache/camel/swagger/RestSwaggerReaderModelTest.java | 7 ++++++-
.../camel-swagger-java/src/test/resources/log4j.properties | 2 +-
3 files changed, 11 insertions(+), 3 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/2a021a19/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 90f5956..a83c03d 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
@@ -190,7 +190,10 @@ public class RestSwaggerReader {
}
for (RestOperationResponseMsgDefinition msg : verb.getResponseMsgs()) {
- Response response = new Response();
+ Response response = op.getResponses().get("" + msg.getCode());
+ if (response == null) {
+ response = new Response();
+ }
response.setDescription(msg.getMessage());
op.addResponse("" + msg.getCode(), response);
}
http://git-wip-us.apache.org/repos/asf/camel/blob/2a021a19/components/camel-swagger-java/src/test/java/org/apache/camel/swagger/RestSwaggerReaderModelTest.java
----------------------------------------------------------------------
diff --git a/components/camel-swagger-java/src/test/java/org/apache/camel/swagger/RestSwaggerReaderModelTest.java b/components/camel-swagger-java/src/test/java/org/apache/camel/swagger/RestSwaggerReaderModelTest.java
index d899613..301421f 100644
--- a/components/camel-swagger-java/src/test/java/org/apache/camel/swagger/RestSwaggerReaderModelTest.java
+++ b/components/camel-swagger-java/src/test/java/org/apache/camel/swagger/RestSwaggerReaderModelTest.java
@@ -48,6 +48,7 @@ public class RestSwaggerReaderModelTest extends CamelTestSupport {
.consumes("application/json").produces("application/json")
.get("/{id}").description("Find user by id").outType(User.class)
+ .responseMessage().message("The user returned").endResponseMessage()
.param().name("id").type(RestParamType.path).description("The id of the user to get").dataType("integer").endParam()
.to("bean:userService?method=getUser(${header.id})")
@@ -56,6 +57,7 @@ public class RestSwaggerReaderModelTest extends CamelTestSupport {
.to("bean:userService?method=updateUser")
.get("/findAll").description("Find all users").outTypeList(User.class)
+ .responseMessage().message("All the found users").endResponseMessage()
.to("bean:userService?method=listUsers");
}
};
@@ -70,6 +72,9 @@ public class RestSwaggerReaderModelTest extends CamelTestSupport {
config.setHost("localhost:8080");
config.setSchemes(new String[]{"http"});
config.setBasePath("/api");
+ config.setTitle("Camel User store");
+ config.setLicense("Apache 2.0");
+ config.setLicenseUrl("http://www.apache.org/licenses/LICENSE-2.0.html");
RestSwaggerReader reader = new RestSwaggerReader();
Swagger swagger = reader.read(rest, config, new DefaultClassResolver());
@@ -83,7 +88,7 @@ public class RestSwaggerReaderModelTest extends CamelTestSupport {
log.info(json);
assertTrue(json.contains("\"host\" : \"localhost:8080\""));
- assertTrue(json.contains("\"description\" : \"Output type\""));
+ assertTrue(json.contains("\"description\" : \"The user returned\""));
assertTrue(json.contains("\"$ref\" : \"#/definitions/User\""));
assertTrue(json.contains("\"x-className\""));
assertTrue(json.contains("\"format\" : \"org.apache.camel.swagger.User\""));
http://git-wip-us.apache.org/repos/asf/camel/blob/2a021a19/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 e5d9b29..6e040b0 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, out
+log4j.rootLogger=INFO, file
# uncomment the following to enable camel debugging
#log4j.logger.org.apache.camel.swagger=TRACE
[11/21] 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/bf36f614
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/bf36f614
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/bf36f614
Branch: refs/heads/master
Commit: bf36f6149d3280e160cee8be12fd03ada3e81d35
Parents: 0fd7e66
Author: Claus Ibsen <da...@apache.org>
Authored: Fri Sep 18 11:25:39 2015 +0200
Committer: Claus Ibsen <da...@apache.org>
Committed: Fri Sep 18 16:16:13 2015 +0200
----------------------------------------------------------------------
.../swagger/DefaultCamelSwaggerServlet.java | 4 +-
.../camel/swagger/RestModelConverters.java | 41 ++
.../RestSwaggerApiDeclarationServlet.java | 5 +-
.../apache/camel/swagger/RestSwaggerReader.java | 125 +++++-
.../swagger/RestSwaggerReaderModelTest.java | 94 +++++
.../camel/swagger/RestSwaggerReaderTest.java | 3 +-
.../java/org/apache/camel/swagger/User.java | 53 +++
examples/camel-example-swagger-java/pom.xml | 382 ++++++++++---------
.../org/apache/camel/example/rest/User.java | 1 -
.../src/main/resources/camel-config-xml.xml | 2 +-
10 files changed, 500 insertions(+), 210 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/bf36f614/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
index 12d79aa..2a68868 100644
--- 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
@@ -42,7 +42,7 @@ public class DefaultCamelSwaggerServlet extends RestSwaggerApiDeclarationServlet
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
+ // filter out older Camel versions as this requires Camel 2.15 or better (rest-dsl)
String version = (String) server.getAttribute(on, "CamelVersion");
if (CamelVersionHelper.isGE("2.15.0", version)) {
found = on;
@@ -75,7 +75,7 @@ public class DefaultCamelSwaggerServlet extends RestSwaggerApiDeclarationServlet
id = id.substring(1, id.length() - 1);
}
- // filter out older Camel versions as this requires Camel 2.15 or better
+ // filter out older Camel versions as this requires Camel 2.15 or better (rest-dsl)
String version = (String) server.getAttribute(on, "CamelVersion");
if (CamelVersionHelper.isGE("2.15.0", version)) {
answer.add(id);
http://git-wip-us.apache.org/repos/asf/camel/blob/bf36f614/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/RestModelConverters.java
----------------------------------------------------------------------
diff --git a/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/RestModelConverters.java b/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/RestModelConverters.java
new file mode 100644
index 0000000..ed5b705
--- /dev/null
+++ b/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/RestModelConverters.java
@@ -0,0 +1,41 @@
+/**
+ * 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 io.swagger.converter.ModelConverters;
+import io.swagger.models.Model;
+import io.swagger.models.properties.StringProperty;
+
+/**
+ * A Camel extended {@link ModelConverters} where we appending vendor extensions
+ * to include the java class name of the model classes.
+ */
+public class RestModelConverters extends ModelConverters {
+
+ public Map<String, Model> readClass(Class clazz) {
+ String name = clazz.getName();
+ Map<String, Model> resolved = super.read(clazz);
+ if (resolved != null) {
+ for (Model model : resolved.values()) {
+ model.getVendorExtensions().put("x-className", new StringProperty(name));
+ }
+ }
+ return resolved;
+ }
+}
http://git-wip-us.apache.org/repos/asf/camel/blob/bf36f614/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 ceb5af2..6bc5e50 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
@@ -31,6 +31,7 @@ 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.impl.DefaultClassResolver;
import org.apache.camel.model.rest.RestDefinition;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
@@ -123,7 +124,7 @@ public abstract class RestSwaggerApiDeclarationServlet extends HttpServlet {
}
}
} catch (Exception e) {
- LOG.warn("Error rendering swagger due " + e.getMessage());
+ LOG.warn("Error rendering swagger due " + e.getMessage(), e);
}
}
@@ -142,7 +143,7 @@ public abstract class RestSwaggerApiDeclarationServlet extends HttpServlet {
// TODO: combine the rests
for (RestDefinition rest : rests) {
- Swagger swagger = reader.read(rest, swaggerConfig);
+ Swagger swagger = reader.read(rest, swaggerConfig, new DefaultClassResolver());
ObjectMapper mapper = new ObjectMapper();
mapper.enable(SerializationFeature.INDENT_OUTPUT);
http://git-wip-us.apache.org/repos/asf/camel/blob/bf36f614/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 e6172af..e664529 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
@@ -19,10 +19,15 @@ package org.apache.camel.swagger;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Comparator;
+import java.util.LinkedHashSet;
import java.util.List;
import java.util.Locale;
+import java.util.Map;
+import java.util.Set;
import io.swagger.jaxrs.config.BeanConfig;
+import io.swagger.models.Model;
+import io.swagger.models.ModelImpl;
import io.swagger.models.Operation;
import io.swagger.models.Path;
import io.swagger.models.Response;
@@ -34,15 +39,30 @@ 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 io.swagger.models.properties.ArrayProperty;
+import io.swagger.models.properties.RefProperty;
+import io.swagger.models.properties.StringProperty;
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.spi.ClassResolver;
+/**
+ * A Camel REST-DSL swagger reader that parse the rest-dsl into a swagger model representation.
+ */
public class RestSwaggerReader {
- public Swagger read(RestDefinition rest, BeanConfig config) {
+ /**
+ * Read the REST-DSL definition and parse that as a Swagger model representation
+ *
+ * @param rest the rest-dsl
+ * @param config the swagger configuration
+ * @param classResolver class resolver to use
+ * @return the swagger model
+ */
+ public Swagger read(RestDefinition rest, BeanConfig config, ClassResolver classResolver) {
Swagger swagger = new Swagger();
config.configure(swagger);
@@ -50,6 +70,31 @@ public class RestSwaggerReader {
// must sort the verbs by uri so we group them together when an uri has multiple operations
Collections.sort(verbs, new VerbOrdering());
+ // gather all types in use
+ Set<String> types = new LinkedHashSet<>();
+ for (VerbDefinition verb : verbs) {
+ String type = verb.getType();
+ if (type != null) {
+ if (type.endsWith("[]")) {
+ type = type.substring(0, type.length() - 2);
+ }
+ types.add(type);
+ }
+ type = verb.getOutType();
+ if (type != null) {
+ if (type.endsWith("[]")) {
+ type = type.substring(0, type.length() - 2);
+ }
+ types.add(type);
+ }
+ }
+
+ // use annotation scanner to find models (annotated classes)
+ for (String type : types) {
+ Class<?> clazz = classResolver.resolveClass(type);
+ appendModels(clazz, swagger);
+ }
+
// used during gathering of apis
List<Path> paths = new ArrayList<>();
@@ -71,21 +116,26 @@ 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) {
- op.consumes(rest.getConsumes());
+ String consumes = verb.getConsumes() != null ? verb.getConsumes() : rest.getConsumes();
+ if (consumes != null) {
+ String[] parts = consumes.split(",");
+ for (String part : parts) {
+ op.addConsumes(part);
+ }
}
- if (verb.getProduces() != null) {
- op.produces(verb.getProduces());
- } else if (rest.getProduces() != null) {
- op.produces(rest.getProduces());
+
+ String produces = verb.getProduces() != null ? verb.getProduces() : rest.getProduces();
+ if (produces != null) {
+ String[] parts = produces.split(",");
+ for (String part : parts) {
+ op.addProduces(part);
+ }
}
+
if (verb.getDescriptionText() != null) {
op.summary(verb.getDescriptionText());
}
+
for (RestOperationParamDefinition param : verb.getParams()) {
Parameter parameter = null;
if (param.getType().equals(RestParamType.body)) {
@@ -108,12 +158,47 @@ public class RestSwaggerReader {
if (parameter instanceof SerializableParameter) {
SerializableParameter sp = (SerializableParameter) parameter;
- sp.setType(param.getDataType());
+
+ // TODO: like response object with type refer to model
+ if (param.getDataType() != null) {
+ sp.setType(param.getDataType());
+ } else if (verb.getType() != null) {
+ boolean array = verb.getType().endsWith("[]");
+ if (array) {
+ sp.setType("array");
+ } else {
+ sp.setType(verb.getType());
+ }
+ }
}
op.addParameter(parameter);
}
}
+
+ if (verb.getOutType() != null) {
+ Response response = new Response();
+ boolean array = verb.getOutType().endsWith("[]");
+ String type = array ? verb.getOutType().substring(0, verb.getOutType().length() - 2) : verb.getOutType();
+ // lookup in models to use key instead of FQN
+
+ for (Model model : swagger.getDefinitions().values()) {
+ StringProperty modelType = (StringProperty) model.getVendorExtensions().get("x-className");
+ if (modelType != null && type.equals(modelType.getFormat())) {
+ type = ((ModelImpl) model).getName();
+ break;
+ }
+ }
+
+ if (array) {
+ response.setSchema(new ArrayProperty(new RefProperty(type)));
+ } else {
+ response.setSchema(new RefProperty(type));
+ }
+ response.setDescription("Output type");
+ op.addResponse("200", response);
+ }
+
for (RestOperationResponseMsgDefinition msg : verb.getResponseMsgs()) {
Response response = new Response();
response.setDescription(msg.getMessage());
@@ -123,13 +208,27 @@ public class RestSwaggerReader {
// add path
swagger.path(opPath, path);
- // TODO: add model parser for swagger annotations in the model/schema
}
return swagger;
}
/**
+ * If the class is annotated with swagger annotations its parsed into a Swagger model representation
+ * which is added to swagger
+ *
+ * @param clazz the class such as pojo with swagger annotation
+ * @param swagger the swagger model
+ */
+ private void appendModels(Class clazz, Swagger swagger) {
+ RestModelConverters converters = new RestModelConverters();
+ final Map<String, Model> models = converters.readClass(clazz);
+ for (Map.Entry<String, Model> entry : models.entrySet()) {
+ swagger.model(entry.getKey(), entry.getValue());
+ }
+ }
+
+ /**
* To sort the rest operations
*/
private static class VerbOrdering implements Comparator<VerbDefinition> {
http://git-wip-us.apache.org/repos/asf/camel/blob/bf36f614/components/camel-swagger-java/src/test/java/org/apache/camel/swagger/RestSwaggerReaderModelTest.java
----------------------------------------------------------------------
diff --git a/components/camel-swagger-java/src/test/java/org/apache/camel/swagger/RestSwaggerReaderModelTest.java b/components/camel-swagger-java/src/test/java/org/apache/camel/swagger/RestSwaggerReaderModelTest.java
new file mode 100644
index 0000000..d899613
--- /dev/null
+++ b/components/camel-swagger-java/src/test/java/org/apache/camel/swagger/RestSwaggerReaderModelTest.java
@@ -0,0 +1,94 @@
+/**
+ * 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.DefaultClassResolver;
+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;
+
+public class RestSwaggerReaderModelTest 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 {
+ // this user REST service is json only
+ rest("/user").description("User rest service")
+ .consumes("application/json").produces("application/json")
+
+ .get("/{id}").description("Find user by id").outType(User.class)
+ .param().name("id").type(RestParamType.path).description("The id of the user to get").dataType("integer").endParam()
+ .to("bean:userService?method=getUser(${header.id})")
+
+ .put().description("Updates or create a user").type(User.class)
+ .param().name("body").type(RestParamType.body).description("The user to update or create").endParam()
+ .to("bean:userService?method=updateUser")
+
+ .get("/findAll").description("Find all users").outTypeList(User.class)
+ .to("bean:userService?method=listUsers");
+ }
+ };
+ }
+
+ @Test
+ public void testReaderRead() throws Exception {
+ RestDefinition rest = context.getRestDefinitions().get(0);
+ assertNotNull(rest);
+
+ BeanConfig config = new BeanConfig();
+ config.setHost("localhost:8080");
+ config.setSchemes(new String[]{"http"});
+ config.setBasePath("/api");
+ RestSwaggerReader reader = new RestSwaggerReader();
+
+ Swagger swagger = reader.read(rest, config, new DefaultClassResolver());
+ 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("\"host\" : \"localhost:8080\""));
+ assertTrue(json.contains("\"description\" : \"Output type\""));
+ assertTrue(json.contains("\"$ref\" : \"#/definitions/User\""));
+ assertTrue(json.contains("\"x-className\""));
+ assertTrue(json.contains("\"format\" : \"org.apache.camel.swagger.User\""));
+
+ context.stop();
+ }
+
+}
http://git-wip-us.apache.org/repos/asf/camel/blob/bf36f614/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 baefb8f..b7c9de3 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
@@ -22,6 +22,7 @@ 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.DefaultClassResolver;
import org.apache.camel.impl.JndiRegistry;
import org.apache.camel.model.rest.RestDefinition;
import org.apache.camel.model.rest.RestParamType;
@@ -68,7 +69,7 @@ public class RestSwaggerReaderTest extends CamelTestSupport {
config.setBasePath("/api");
RestSwaggerReader reader = new RestSwaggerReader();
- Swagger swagger = reader.read(rest, config);
+ Swagger swagger = reader.read(rest, config, new DefaultClassResolver());
assertNotNull(swagger);
ObjectMapper mapper = new ObjectMapper();
http://git-wip-us.apache.org/repos/asf/camel/blob/bf36f614/components/camel-swagger-java/src/test/java/org/apache/camel/swagger/User.java
----------------------------------------------------------------------
diff --git a/components/camel-swagger-java/src/test/java/org/apache/camel/swagger/User.java b/components/camel-swagger-java/src/test/java/org/apache/camel/swagger/User.java
new file mode 100644
index 0000000..17c68a0
--- /dev/null
+++ b/components/camel-swagger-java/src/test/java/org/apache/camel/swagger/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.swagger;
+
+import io.swagger.annotations.ApiModel;
+import io.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/bf36f614/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 1218033..09b0ba7 100755
--- a/examples/camel-example-swagger-java/pom.xml
+++ b/examples/camel-example-swagger-java/pom.xml
@@ -15,195 +15,197 @@
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.1.2</swagger-ui.version>
- <logback-version>1.1.3</logback-version>
- <swagger.url>https://github.com/swagger-api/swagger-ui/archive</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 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.1.2</swagger-ui.version>
+ <logback-version>1.1.3</logback-version>
+ <swagger.url>https://github.com/swagger-api/swagger-ui/archive</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/bf36f614/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 a1c6b87..09c0391 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,7 +16,6 @@
*/
package org.apache.camel.example.rest;
-
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
http://git-wip-us.apache.org/repos/asf/camel/blob/bf36f614/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
index cd6fdf0..8ec9b0b 100755
--- 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
@@ -49,7 +49,7 @@
<!-- 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"/>
+ <param name="id" type="path" description="The id of the user to get" dataType="integer"/>
<to uri="bean:userService?method=getUser(${header.id})"/>
</get>
[17/21] 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/d54f0bc3
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/d54f0bc3
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/d54f0bc3
Branch: refs/heads/master
Commit: d54f0bc33e3dd4ba2e2976c5412e016b835f5dee
Parents: c76cbd1
Author: Claus Ibsen <da...@apache.org>
Authored: Fri Sep 18 14:04:07 2015 +0200
Committer: Claus Ibsen <da...@apache.org>
Committed: Fri Sep 18 16:16:14 2015 +0200
----------------------------------------------------------------------
.../RestSwaggerApiDeclarationServlet.java | 52 +++++++++++++++-----
.../apache/camel/swagger/RestSwaggerReader.java | 3 +-
.../src/main/webapp/WEB-INF/web.xml | 6 ++-
3 files changed, 48 insertions(+), 13 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/d54f0bc3/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 6bc5e50..68d621b 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
@@ -30,6 +30,9 @@ 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.Contact;
+import io.swagger.models.Info;
+import io.swagger.models.License;
import io.swagger.models.Swagger;
import org.apache.camel.impl.DefaultClassResolver;
import org.apache.camel.model.rest.RestDefinition;
@@ -68,20 +71,47 @@ public abstract class RestSwaggerApiDeclarationServlet extends HttpServlet {
if (s != null) {
cors = "true".equalsIgnoreCase(s);
}
+ s = config.getInitParameter("schemas");
+ if (s != null) {
+ String[] schemas = s.split(",");
+ swaggerConfig.setSchemes(schemas);
+ } else {
+ // assume http by default
+ swaggerConfig.setSchemes(new String[]{"http"});
+ }
+ String version = config.getInitParameter("api.version");
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);
+ String termsOfService = config.getInitParameter("api.termsOfService");
+ String licenseName = config.getInitParameter("api.license.name");
+ String licenseUrl = config.getInitParameter("api.license.url");
+ String contactName = config.getInitParameter("api.contact.name");
+ String contactUrl = config.getInitParameter("api.contact.url");
+ String contactEmail = config.getInitParameter("api.contact.email");
+
+ Info info = new Info();
+ info.setVersion(version);
+ info.setTitle(title);
+ info.setDescription(description);
+ info.setTermsOfService(termsOfService);
+
+ if (licenseName != null || licenseUrl != null) {
+ License license = new License();
+ license.setName(licenseName);
+ license.setUrl(licenseUrl);
+ info.setLicense(license);
+ }
+
+ if (contactName != null || contactUrl != null || contactEmail != null) {
+ Contact contact = new Contact();
+ contact.setName(contactName);
+ contact.setUrl(contactUrl);
+ contact.setEmail(contactEmail);
+ info.setContact(contact);
+ }
+
+ swaggerConfig.setInfo(info);
}
public abstract List<RestDefinition> getRestDefinitions(String camelId) throws Exception;
http://git-wip-us.apache.org/repos/asf/camel/blob/d54f0bc3/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 8f12dfe..1ad8c1f 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
@@ -66,7 +66,6 @@ public class RestSwaggerReader {
*/
public Swagger read(RestDefinition rest, BeanConfig config, ClassResolver classResolver) {
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
@@ -209,6 +208,8 @@ public class RestSwaggerReader {
swagger.path(opPath, path);
}
+ // configure before returning
+ swagger = config.configure(swagger);
return swagger;
}
http://git-wip-us.apache.org/repos/asf/camel/blob/d54f0bc3/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 17e049f..2979553 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
@@ -60,7 +60,7 @@
</init-param>
<init-param>
<param-name>api.version</param-name>
- <param-value>2.0</param-value>
+ <param-value>1.2.3</param-value>
</init-param>
<init-param>
<param-name>api.title</param-name>
@@ -70,6 +70,10 @@
<param-name>api.description</param-name>
<param-value>Camel Rest Example with Swagger that provides an User REST service</param-value>
</init-param>
+ <init-param>
+ <param-name>api.contact.name</param-name>
+ <param-value>The Apache Camel team</param-value>
+ </init-param>
<load-on-startup>2</load-on-startup>
</servlet>
[18/21] 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/e2f5c9f0
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/e2f5c9f0
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/e2f5c9f0
Branch: refs/heads/master
Commit: e2f5c9f075c89a8e74332e4f91a72f733fb0d4ca
Parents: 83341f2
Author: Claus Ibsen <da...@apache.org>
Authored: Fri Sep 18 16:06:07 2015 +0200
Committer: Claus Ibsen <da...@apache.org>
Committed: Fri Sep 18 16:16:15 2015 +0200
----------------------------------------------------------------------
.../swagger/DefaultCamelSwaggerServlet.java | 91 --------------------
.../camel/swagger/RestSwaggerCorsFilter.java | 55 ++++++++++++
.../camel/swagger/RestSwaggerServlet.java | 91 ++++++++++++++++++++
.../src/main/webapp/WEB-INF/web.xml | 9 +-
4 files changed, 149 insertions(+), 97 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/e2f5c9f0/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
deleted file mode 100644
index b3c73e6..0000000
--- a/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/DefaultCamelSwaggerServlet.java
+++ /dev/null
@@ -1,91 +0,0 @@
-/**
- * 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;
-
-/**
- * The default Camel swagger servlet to use when exposing the APIs of the rest-dsl using swagger.
- * <p/>
- * This requires Camel version 2.15 or better at runtime (and JMX to be enabled).
- */
-public class DefaultCamelSwaggerServlet extends RestSwaggerAbstractServlet {
-
- @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 (rest-dsl)
- 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 (rest-dsl)
- 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/e2f5c9f0/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/RestSwaggerCorsFilter.java
----------------------------------------------------------------------
diff --git a/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/RestSwaggerCorsFilter.java b/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/RestSwaggerCorsFilter.java
new file mode 100644
index 0000000..0cf7303
--- /dev/null
+++ b/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/RestSwaggerCorsFilter.java
@@ -0,0 +1,55 @@
+/**
+ * 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 javax.servlet.Filter;
+import javax.servlet.FilterChain;
+import javax.servlet.FilterConfig;
+import javax.servlet.ServletException;
+import javax.servlet.ServletRequest;
+import javax.servlet.ServletResponse;
+import javax.servlet.http.HttpServletResponse;
+
+/**
+ * A simple CORS filter that can used to allow the swagger ui or other API browsers from remote origins to access the
+ * Rest services exposes by this Camel swagger component.
+ */
+public class RestSwaggerCorsFilter implements Filter {
+
+ @Override
+ public void init(FilterConfig filterConfig) throws ServletException {
+ // noop
+ }
+
+ @Override
+ public void destroy() {
+ // noop
+ }
+
+ @Override
+ public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
+ HttpServletResponse res = (HttpServletResponse) response;
+
+ res.setHeader("Access-Control-Allow-Origin", "*");
+ res.setHeader("Access-Control-Allow-Methods", "GET, HEAD, POST, PUT, DELETE, TRACE, OPTIONS, CONNECT, PATCH");
+ res.setHeader("Access-Control-Max-Age", "3600");
+ res.setHeader("Access-Control-Allow-Headers", "Origin, Accept, X-Requested-With, Content-Type, Access-Control-Request-Method, Access-Control-Request-Headers");
+
+ chain.doFilter(request, response);
+ }
+}
http://git-wip-us.apache.org/repos/asf/camel/blob/e2f5c9f0/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/RestSwaggerServlet.java
----------------------------------------------------------------------
diff --git a/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/RestSwaggerServlet.java b/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/RestSwaggerServlet.java
new file mode 100644
index 0000000..7d85e76
--- /dev/null
+++ b/components/camel-swagger-java/src/main/java/org/apache/camel/swagger/RestSwaggerServlet.java
@@ -0,0 +1,91 @@
+/**
+ * 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;
+
+/**
+ * The default Camel swagger servlet to use when exposing the APIs of the rest-dsl using swagger.
+ * <p/>
+ * This requires Camel version 2.15 or better at runtime (and JMX to be enabled).
+ */
+public class RestSwaggerServlet extends RestSwaggerAbstractServlet {
+
+ @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 (rest-dsl)
+ 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 (rest-dsl)
+ 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/e2f5c9f0/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 2979553..35527aa 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
@@ -41,11 +41,10 @@
<load-on-startup>1</load-on-startup>
</servlet>
- <!-- START SNIPPET: e1 -->
- <!-- to setup Camel Swagger api servlet -->
+ <!-- to setup Camel Swagger servlet -->
<servlet>
<servlet-name>ApiDeclarationServlet</servlet-name>
- <servlet-class>org.apache.camel.swagger.DefaultCamelSwaggerServlet</servlet-class>
+ <servlet-class>org.apache.camel.swagger.RestSwaggerServlet</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 -->
@@ -82,7 +81,6 @@
<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>
@@ -90,7 +88,7 @@
<url-pattern>/rest/*</url-pattern>
</servlet-mapping>
- <!-- 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.swagger.RestSwaggerCorsFilter</filter-class>
@@ -101,7 +99,6 @@
<url-pattern>/api-docs/*</url-pattern>
<url-pattern>/rest/*</url-pattern>
</filter-mapping>
- -->
<welcome-file-list>
<welcome-file>home.html</welcome-file>
[04/21] 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/1d5b0dab
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/1d5b0dab
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/1d5b0dab
Branch: refs/heads/master
Commit: 1d5b0dab8751b59044706b20f1b10614bfec5c28
Parents: b10868b
Author: Claus Ibsen <da...@apache.org>
Authored: Thu Sep 17 13:52:53 2015 +0200
Committer: Claus Ibsen <da...@apache.org>
Committed: Fri Sep 18 16:16:11 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/1d5b0dab/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/1d5b0dab/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/1d5b0dab/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/1d5b0dab/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/1d5b0dab/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/1d5b0dab/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/1d5b0dab/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/1d5b0dab/parent/pom.xml
----------------------------------------------------------------------
diff --git a/parent/pom.xml b/parent/pom.xml
index 947c091..18f6f89 100644
--- a/parent/pom.xml
+++ b/parent/pom.xml
@@ -483,6 +483,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>