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/12/24 10:48:29 UTC
[1/2] camel git commit: CAMEL-9447: camel-swagger-java - Add type for
response model
Repository: camel
Updated Branches:
refs/heads/camel-2.16.x feb80b4e6 -> acdd1d098
refs/heads/master 31b4efdaa -> 907416acb
CAMEL-9447: camel-swagger-java - Add type for response model
Project: http://git-wip-us.apache.org/repos/asf/camel/repo
Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/907416ac
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/907416ac
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/907416ac
Branch: refs/heads/master
Commit: 907416acb923a65a4b122859920f99f8c0398ebd
Parents: 31b4efd
Author: Claus Ibsen <da...@apache.org>
Authored: Thu Dec 24 10:47:51 2015 +0100
Committer: Claus Ibsen <da...@apache.org>
Committed: Thu Dec 24 10:47:51 2015 +0100
----------------------------------------------------------------------
.../apache/camel/swagger/RestSwaggerReader.java | 30 +++++++++++++----
.../org/apache/camel/swagger/DayResponse.java | 35 ++++++++++++++++++++
.../swagger/RestSwaggerReaderDayOfWeekTest.java | 8 ++++-
3 files changed, 66 insertions(+), 7 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/907416ac/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 62ef9e3..d0c5a55 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
@@ -109,19 +109,31 @@ public class RestSwaggerReader {
Set<String> types = new LinkedHashSet<>();
for (VerbDefinition verb : verbs) {
String type = verb.getType();
- if (type != null) {
+ if (ObjectHelper.isNotEmpty(type)) {
if (type.endsWith("[]")) {
type = type.substring(0, type.length() - 2);
}
types.add(type);
}
type = verb.getOutType();
- if (type != null) {
+ if (ObjectHelper.isNotEmpty(type)) {
if (type.endsWith("[]")) {
type = type.substring(0, type.length() - 2);
}
types.add(type);
}
+ // there can also be types in response messages
+ if (verb.getResponseMsgs() != null) {
+ for (RestOperationResponseMsgDefinition def : verb.getResponseMsgs()) {
+ type = def.getResponseModel();
+ if (ObjectHelper.isNotEmpty(type)) {
+ if (type.endsWith("[]")) {
+ type = type.substring(0, type.length() - 2);
+ }
+ types.add(type);
+ }
+ }
+ }
}
// use annotation scanner to find models (annotated classes)
@@ -245,6 +257,10 @@ public class RestSwaggerReader {
if (response == null) {
response = new Response();
}
+ if (ObjectHelper.isNotEmpty(msg.getResponseModel())) {
+ Property prop = modelTypeAsProperty(msg.getResponseModel(), swagger);
+ response.setSchema(prop);
+ }
response.setDescription(msg.getMessage());
op.addResponse(msg.getCode(), response);
}
@@ -260,10 +276,12 @@ public class RestSwaggerReader {
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;
+ if (swagger.getDefinitions() != null) {
+ 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;
http://git-wip-us.apache.org/repos/asf/camel/blob/907416ac/components/camel-swagger-java/src/test/java/org/apache/camel/swagger/DayResponse.java
----------------------------------------------------------------------
diff --git a/components/camel-swagger-java/src/test/java/org/apache/camel/swagger/DayResponse.java b/components/camel-swagger-java/src/test/java/org/apache/camel/swagger/DayResponse.java
new file mode 100644
index 0000000..03f4d88
--- /dev/null
+++ b/components/camel-swagger-java/src/test/java/org/apache/camel/swagger/DayResponse.java
@@ -0,0 +1,35 @@
+/**
+ * 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 a day")
+public class DayResponse {
+
+ private String day;
+
+ @ApiModelProperty(value = "The day", required = true)
+ public String getDay() {
+ return day;
+ }
+
+ public void setDay(String day) {
+ this.day = day;
+ }
+}
http://git-wip-us.apache.org/repos/asf/camel/blob/907416ac/components/camel-swagger-java/src/test/java/org/apache/camel/swagger/RestSwaggerReaderDayOfWeekTest.java
----------------------------------------------------------------------
diff --git a/components/camel-swagger-java/src/test/java/org/apache/camel/swagger/RestSwaggerReaderDayOfWeekTest.java b/components/camel-swagger-java/src/test/java/org/apache/camel/swagger/RestSwaggerReaderDayOfWeekTest.java
index 7494733..cd7df02 100644
--- a/components/camel-swagger-java/src/test/java/org/apache/camel/swagger/RestSwaggerReaderDayOfWeekTest.java
+++ b/components/camel-swagger-java/src/test/java/org/apache/camel/swagger/RestSwaggerReaderDayOfWeekTest.java
@@ -48,7 +48,11 @@ public class RestSwaggerReaderDayOfWeekTest extends CamelTestSupport {
.get("/week").description("Day of week")
.param().name("day").type(RestParamType.query).description("Day of week")
- .dataType("string").allowableValues("monday", "tuesday", "wednesday", "thursday", "friday").endParam()
+ .dataType("string").allowableValues("monday", "tuesday", "wednesday", "thursday", "friday")
+ .endParam()
+ .responseMessage()
+ .code(200).responseModel(DayResponse.class)
+ .endResponseMessage()
.to("log:week");
}
};
@@ -77,6 +81,8 @@ public class RestSwaggerReaderDayOfWeekTest extends CamelTestSupport {
assertTrue(json.contains("\"host\" : \"localhost:8080\""));
assertTrue(json.contains("\"enum\" : [ \"monday\", \"tuesday\", \"wednesday\", \"thursday\", \"friday\" ]"));
+ assertTrue(json.contains("\"$ref\" : \"#/definitions/DayResponse\""));
+ assertTrue(json.contains("\"format\" : \"org.apache.camel.swagger.DayResponse\""));
context.stop();
}
[2/2] camel git commit: CAMEL-9447: camel-swagger-java - Add type for
response model
Posted by da...@apache.org.
CAMEL-9447: camel-swagger-java - Add type for response model
Project: http://git-wip-us.apache.org/repos/asf/camel/repo
Commit: http://git-wip-us.apache.org/repos/asf/camel/commit/acdd1d09
Tree: http://git-wip-us.apache.org/repos/asf/camel/tree/acdd1d09
Diff: http://git-wip-us.apache.org/repos/asf/camel/diff/acdd1d09
Branch: refs/heads/camel-2.16.x
Commit: acdd1d098333f6d29075abd69af7bf7b4100e939
Parents: feb80b4
Author: Claus Ibsen <da...@apache.org>
Authored: Thu Dec 24 10:47:51 2015 +0100
Committer: Claus Ibsen <da...@apache.org>
Committed: Thu Dec 24 10:48:21 2015 +0100
----------------------------------------------------------------------
.../apache/camel/swagger/RestSwaggerReader.java | 30 +++++++++++++----
.../org/apache/camel/swagger/DayResponse.java | 35 ++++++++++++++++++++
.../swagger/RestSwaggerReaderDayOfWeekTest.java | 8 ++++-
3 files changed, 66 insertions(+), 7 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/camel/blob/acdd1d09/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 62ef9e3..d0c5a55 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
@@ -109,19 +109,31 @@ public class RestSwaggerReader {
Set<String> types = new LinkedHashSet<>();
for (VerbDefinition verb : verbs) {
String type = verb.getType();
- if (type != null) {
+ if (ObjectHelper.isNotEmpty(type)) {
if (type.endsWith("[]")) {
type = type.substring(0, type.length() - 2);
}
types.add(type);
}
type = verb.getOutType();
- if (type != null) {
+ if (ObjectHelper.isNotEmpty(type)) {
if (type.endsWith("[]")) {
type = type.substring(0, type.length() - 2);
}
types.add(type);
}
+ // there can also be types in response messages
+ if (verb.getResponseMsgs() != null) {
+ for (RestOperationResponseMsgDefinition def : verb.getResponseMsgs()) {
+ type = def.getResponseModel();
+ if (ObjectHelper.isNotEmpty(type)) {
+ if (type.endsWith("[]")) {
+ type = type.substring(0, type.length() - 2);
+ }
+ types.add(type);
+ }
+ }
+ }
}
// use annotation scanner to find models (annotated classes)
@@ -245,6 +257,10 @@ public class RestSwaggerReader {
if (response == null) {
response = new Response();
}
+ if (ObjectHelper.isNotEmpty(msg.getResponseModel())) {
+ Property prop = modelTypeAsProperty(msg.getResponseModel(), swagger);
+ response.setSchema(prop);
+ }
response.setDescription(msg.getMessage());
op.addResponse(msg.getCode(), response);
}
@@ -260,10 +276,12 @@ public class RestSwaggerReader {
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;
+ if (swagger.getDefinitions() != null) {
+ 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;
http://git-wip-us.apache.org/repos/asf/camel/blob/acdd1d09/components/camel-swagger-java/src/test/java/org/apache/camel/swagger/DayResponse.java
----------------------------------------------------------------------
diff --git a/components/camel-swagger-java/src/test/java/org/apache/camel/swagger/DayResponse.java b/components/camel-swagger-java/src/test/java/org/apache/camel/swagger/DayResponse.java
new file mode 100644
index 0000000..03f4d88
--- /dev/null
+++ b/components/camel-swagger-java/src/test/java/org/apache/camel/swagger/DayResponse.java
@@ -0,0 +1,35 @@
+/**
+ * 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 a day")
+public class DayResponse {
+
+ private String day;
+
+ @ApiModelProperty(value = "The day", required = true)
+ public String getDay() {
+ return day;
+ }
+
+ public void setDay(String day) {
+ this.day = day;
+ }
+}
http://git-wip-us.apache.org/repos/asf/camel/blob/acdd1d09/components/camel-swagger-java/src/test/java/org/apache/camel/swagger/RestSwaggerReaderDayOfWeekTest.java
----------------------------------------------------------------------
diff --git a/components/camel-swagger-java/src/test/java/org/apache/camel/swagger/RestSwaggerReaderDayOfWeekTest.java b/components/camel-swagger-java/src/test/java/org/apache/camel/swagger/RestSwaggerReaderDayOfWeekTest.java
index 7494733..cd7df02 100644
--- a/components/camel-swagger-java/src/test/java/org/apache/camel/swagger/RestSwaggerReaderDayOfWeekTest.java
+++ b/components/camel-swagger-java/src/test/java/org/apache/camel/swagger/RestSwaggerReaderDayOfWeekTest.java
@@ -48,7 +48,11 @@ public class RestSwaggerReaderDayOfWeekTest extends CamelTestSupport {
.get("/week").description("Day of week")
.param().name("day").type(RestParamType.query).description("Day of week")
- .dataType("string").allowableValues("monday", "tuesday", "wednesday", "thursday", "friday").endParam()
+ .dataType("string").allowableValues("monday", "tuesday", "wednesday", "thursday", "friday")
+ .endParam()
+ .responseMessage()
+ .code(200).responseModel(DayResponse.class)
+ .endResponseMessage()
.to("log:week");
}
};
@@ -77,6 +81,8 @@ public class RestSwaggerReaderDayOfWeekTest extends CamelTestSupport {
assertTrue(json.contains("\"host\" : \"localhost:8080\""));
assertTrue(json.contains("\"enum\" : [ \"monday\", \"tuesday\", \"wednesday\", \"thursday\", \"friday\" ]"));
+ assertTrue(json.contains("\"$ref\" : \"#/definitions/DayResponse\""));
+ assertTrue(json.contains("\"format\" : \"org.apache.camel.swagger.DayResponse\""));
context.stop();
}