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 2022/01/21 14:58:28 UTC
[camel] branch main updated: CAMEL-17491: do not add context path to the paths of the operations. (#6795)
This is an automated email from the ASF dual-hosted git repository.
davsclaus pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel.git
The following commit(s) were added to refs/heads/main by this push:
new a4f7ef3 CAMEL-17491: do not add context path to the paths of the operations. (#6795)
a4f7ef3 is described below
commit a4f7ef3bb4614d6d7904b3f8fbdc482dd33328d9
Author: klease <38...@users.noreply.github.com>
AuthorDate: Fri Jan 21 15:57:55 2022 +0100
CAMEL-17491: do not add context path to the paths of the operations. (#6795)
* CAMEL-17491: do not add context path to the paths of the operations.
Add a unit test to verify the absence of the context-path.
* CAMEL-17491: add a note in the 3.15 upgrade notes.
---
.../apache/camel/openapi/RestOpenApiReader.java | 11 --
.../openapi/RestOpenApiReaderContextPathTest.java | 152 +++++++++++++++++++++
.../ROOT/pages/camel-3x-upgrade-guide-3_15.adoc | 4 +
3 files changed, 156 insertions(+), 11 deletions(-)
diff --git a/components/camel-openapi-java/src/main/java/org/apache/camel/openapi/RestOpenApiReader.java b/components/camel-openapi-java/src/main/java/org/apache/camel/openapi/RestOpenApiReader.java
index c734229..2a99e36 100644
--- a/components/camel-openapi-java/src/main/java/org/apache/camel/openapi/RestOpenApiReader.java
+++ b/components/camel-openapi-java/src/main/java/org/apache/camel/openapi/RestOpenApiReader.java
@@ -474,17 +474,6 @@ public class RestOpenApiReader {
private String buildBasePath(CamelContext camelContext, RestDefinition rest) {
// used during gathering of apis
String basePath = FileUtil.stripLeadingSeparator(getValue(camelContext, rest.getPath()));
-
- // is there any context-path which we must use in base path for each rest service
- String cp = camelContext.getRestConfiguration() != null ? camelContext.getRestConfiguration().getContextPath() : null;
- if (cp != null) {
- cp = FileUtil.stripLeadingSeparator(cp);
- if (basePath != null) {
- basePath = cp + "/" + basePath;
- } else {
- basePath = cp;
- }
- }
// must start with leading slash
if (basePath != null && !basePath.startsWith("/")) {
basePath = "/" + basePath;
diff --git a/components/camel-openapi-java/src/test/java/org/apache/camel/openapi/RestOpenApiReaderContextPathTest.java b/components/camel-openapi-java/src/test/java/org/apache/camel/openapi/RestOpenApiReaderContextPathTest.java
new file mode 100644
index 0000000..fb82ac5
--- /dev/null
+++ b/components/camel-openapi-java/src/test/java/org/apache/camel/openapi/RestOpenApiReaderContextPathTest.java
@@ -0,0 +1,152 @@
+/*
+ * 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.openapi;
+
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.SerializationFeature;
+import io.apicurio.datamodels.Library;
+import io.apicurio.datamodels.openapi.models.OasDocument;
+import io.apicurio.datamodels.openapi.v2.models.Oas20Info;
+import io.apicurio.datamodels.openapi.v3.models.Oas30Info;
+import org.apache.camel.BindToRegistry;
+import org.apache.camel.builder.RouteBuilder;
+import org.apache.camel.impl.engine.DefaultClassResolver;
+import org.apache.camel.model.rest.RestParamType;
+import org.apache.camel.test.junit5.CamelTestSupport;
+import org.junit.jupiter.api.Test;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertNotNull;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+
+public class RestOpenApiReaderContextPathTest extends CamelTestSupport {
+
+ private Logger log = LoggerFactory.getLogger(getClass());
+
+ @BindToRegistry("dummy-rest")
+ private DummyRestConsumerFactory factory = new DummyRestConsumerFactory();
+
+ @Override
+ protected RouteBuilder createRouteBuilder() throws Exception {
+ return new RouteBuilder() {
+ @Override
+ public void configure() throws Exception {
+ 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").example("Donald Duck").endParam()
+ .param().name("filter").description("Filters to apply to the entity.").type(RestParamType.query)
+ .dataType("array").arrayType("date-time").endParam().to("log:hi")
+ .get("/bye/{name}").description("Saying bye").param().name("name")
+ .type(RestParamType.path).dataType("string").description("Who is it").example("Donald Duck").endParam()
+ .responseMessage().code(200).message("A reply number")
+ .responseModel(float.class).example("success", "123").example("error", "-1").endResponseMessage()
+ .to("log:bye").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")
+ .example("application/xml", "<hello>Hi</hello>").endParam().to("log:bye");
+ }
+ };
+ }
+
+ @Test
+ public void testReaderRead() throws Exception {
+ BeanConfig config = new BeanConfig();
+ config.setHost("localhost:8080");
+ config.setSchemes(new String[] { "http" });
+ config.setBasePath("/api");
+ Oas20Info info = new Oas20Info();
+ config.setInfo(info);
+ config.setVersion("2.0");
+ RestOpenApiReader reader = new RestOpenApiReader();
+
+ OasDocument openApi = reader.read(context, context.getRestDefinitions(), config, context.getName(),
+ new DefaultClassResolver());
+ assertNotNull(openApi);
+
+ ObjectMapper mapper = new ObjectMapper();
+ mapper.enable(SerializationFeature.INDENT_OUTPUT);
+ mapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);
+ Object dump = Library.writeNode(openApi);
+ String json = mapper.writeValueAsString(dump);
+
+ log.info(json);
+
+ 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}\""));
+ assertFalse(json.contains("\"/api/hello/bye/{name}\""));
+ assertTrue(json.contains("\"/hello/hi/{name}\""));
+ assertFalse(json.contains("\"/api/hello/hi/{name}\""));
+ assertTrue(json.contains("\"type\" : \"number\""));
+ assertTrue(json.contains("\"format\" : \"float\""));
+ assertTrue(json.contains("\"application/xml\" : \"<hello>Hi</hello>\""));
+ assertTrue(json.contains("\"x-example\" : \"Donald Duck\""));
+ assertTrue(json.contains("\"success\" : \"123\""));
+ assertTrue(json.contains("\"error\" : \"-1\""));
+ assertTrue(json.contains("\"type\" : \"array\""));
+
+ context.stop();
+ }
+
+ @Test
+ public void testReaderReadV3() throws Exception {
+ BeanConfig config = new BeanConfig();
+ config.setHost("localhost:8080");
+ config.setSchemes(new String[] { "http" });
+ config.setBasePath("/api");
+ Oas30Info info = new Oas30Info();
+ config.setInfo(info);
+ RestOpenApiReader reader = new RestOpenApiReader();
+
+ OasDocument openApi = reader.read(context, context.getRestDefinitions(), config, context.getName(),
+ new DefaultClassResolver());
+ assertNotNull(openApi);
+
+ ObjectMapper mapper = new ObjectMapper();
+ mapper.enable(SerializationFeature.INDENT_OUTPUT);
+ mapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);
+ Object dump = Library.writeNode(openApi);
+ String json = mapper.writeValueAsString(dump);
+
+ log.info(json);
+
+ assertTrue(json.contains("\"url\" : \"http://localhost:8080/api\""));
+ assertTrue(json.contains("\"/hello/bye\""));
+ assertTrue(json.contains("\"summary\" : \"To update the greeting message\""));
+ assertTrue(json.contains("\"/hello/bye/{name}\""));
+ assertFalse(json.contains("\"/api/hello/bye/{name}\""));
+ assertTrue(json.contains("\"/hello/hi/{name}\""));
+ assertFalse(json.contains("\"/api/hello/hi/{name}\""));
+ assertTrue(json.contains("\"type\" : \"number\""));
+ assertTrue(json.contains("\"format\" : \"float\""));
+ assertTrue(json.contains("\"application/xml\" : \"<hello>Hi</hello>\""));
+ assertTrue(json.contains("\"x-example\" : \"Donald Duck\""));
+ assertTrue(json.contains("\"success\" : \"123\""));
+ assertTrue(json.contains("\"error\" : \"-1\""));
+ assertTrue(json.contains("\"type\" : \"array\""));
+ assertTrue(json.contains("\"format\" : \"date-time\""));
+
+ context.stop();
+ }
+
+}
diff --git a/docs/user-manual/modules/ROOT/pages/camel-3x-upgrade-guide-3_15.adoc b/docs/user-manual/modules/ROOT/pages/camel-3x-upgrade-guide-3_15.adoc
index 2d4914a..5b8d758 100644
--- a/docs/user-manual/modules/ROOT/pages/camel-3x-upgrade-guide-3_15.adoc
+++ b/docs/user-manual/modules/ROOT/pages/camel-3x-upgrade-guide-3_15.adoc
@@ -205,3 +205,7 @@ Removed the option `startDelaySeconds` as this does not work correctly and cause
The rabbitmq producer has migrated from commons-poll v1 to v2.
+=== camel-openapi-java
+
+The contextPath specified in the REST configuration is no longer added to the paths of the operations in the generated openapi specification.
+