This is an automated email from the ASF dual-hosted git repository.
davsclaus pushed a commit to branch openapi2
in repository https://gitbox.apache.org/repos/asf/camel.git
commit 36bc449ba76ccdab928ae7f2f9cd09d5f1beb5e3
Author: Claus Ibsen <claus.ib...@gmail.com>
AuthorDate: Wed Mar 27 13:04:27 2024 +0100
CAMEL-20557: Rest DSL to use openapi spec directly
---
.../camel/catalog/components/rest-openapi.json | 31 ++++++------
.../camel/catalog/models/restConfiguration.json | 2 +-
...PlatformHttpRestOpenApiConsumerRestDslTest.java | 45 +++++++++++++++++
.../openapi/RestOpenApiComponentConfigurer.java | 6 +++
.../openapi/RestOpenApiEndpointConfigurer.java | 6 +++
.../openapi/RestOpenApiEndpointUriFactory.java | 3 +-
.../camel/component/rest/openapi/rest-openapi.json | 58 +++++++++++-----------
.../DefaultRestOpenapiProcessorStrategy.java | 32 ++++++++++++
.../rest/openapi/RestOpenApiComponent.java | 11 ++++
.../rest/openapi/RestOpenApiEndpoint.java | 12 ++++-
.../rest/openapi/RestOpenApiProcessor.java | 12 ++++-
.../rest/openapi/RestOpenapiProcessorStrategy.java | 12 +++++
.../apache/camel/model/rest/restConfiguration.json | 2 +-
.../apache/camel/model/rest/OpenApiDefinition.java | 19 +++++++
.../model/rest/RestConfigurationDefinition.java | 4 +-
.../apache/camel/model/rest/RestDefinition.java | 9 ++--
.../java/org/apache/camel/xml/in/ModelParser.java | 8 ++-
.../java/org/apache/camel/xml/out/ModelWriter.java | 1 +
.../org/apache/camel/yaml/out/ModelWriter.java | 1 +
.../dsl/RestOpenApiEndpointBuilderFactory.java | 15 ++++++
.../camel/kotlin/components/RestOpenapiUriDsl.kt | 7 +++
.../dsl/yaml/deserializers/ModelDeserializers.java | 2 +-
.../generated/resources/schema/camelYamlDsl.json | 2 +-
23 files changed, 243 insertions(+), 57 deletions(-)
diff --git
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/rest-openapi.json
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/rest-openapi.json
index a2f378c6e67..e224a0d248e 100644
---
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/rest-openapi.json
+++
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/components/rest-openapi.json
@@ -45,20 +45,21 @@
"specificationUri": { "index": 0, "kind": "path", "displayName":
"Specification Uri", "group": "common", "label": "common", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": "openapi.json",
"description": "Path to the OpenApi specification file. The scheme, host base
path are taken from this specification, but these can be overridden with
properties on the component or endpoint level. If not [...]
"operationId": { "index": 1, "kind": "path", "displayName": "Operation
Id", "group": "producer", "label": "producer", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "description": "ID of the operation from the OpenApi
specification. This is required when using producer" },
"requestValidationEnabled": { "index": 2, "kind": "parameter",
"displayName": "Request Validation Enabled", "group": "common", "label": "",
"required": false, "type": "boolean", "javaType": "boolean", "deprecated":
false, "autowired": false, "secret": false, "defaultValue": false,
"description": "Enable validation of requests against the configured OpenAPI
specification" },
- "missingOperation": { "index": 3, "kind": "parameter", "displayName":
"Missing Operation", "group": "consumer", "label": "consumer", "required":
false, "type": "string", "javaType": "java.lang.String", "enum": [ "fail",
"ignore", "mock" ], "deprecated": false, "autowired": false, "secret": false,
"defaultValue": "fail", "description": "Whether the consumer should fail,ignore
or return a mock response for OpenAPI operations that are not mapped to a
corresponding route." },
- "bridgeErrorHandler": { "index": 4, "kind": "parameter", "displayName":
"Bridge Error Handler", "group": "consumer (advanced)", "label":
"consumer,advanced", "required": false, "type": "boolean", "javaType":
"boolean", "deprecated": false, "autowired": false, "secret": false,
"defaultValue": false, "description": "Allows for bridging the consumer to the
Camel routing Error Handler, which mean any exceptions (if possible) occurred
while the Camel consumer is trying to pickup incoming [...]
- "consumerComponentName": { "index": 5, "kind": "parameter", "displayName":
"Consumer Component Name", "group": "consumer (advanced)", "label":
"consumer,advanced", "required": false, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "autowired": false, "secret": false,
"description": "Name of the Camel component that will service the requests. The
component must be present in Camel registry and it must implement
RestOpenApiConsumerFactory service provider interfa [...]
- "exceptionHandler": { "index": 6, "kind": "parameter", "displayName":
"Exception Handler", "group": "consumer (advanced)", "label":
"consumer,advanced", "required": false, "type": "object", "javaType":
"org.apache.camel.spi.ExceptionHandler", "optionalPrefix": "consumer.",
"deprecated": false, "autowired": false, "secret": false, "description": "To
let the consumer use a custom ExceptionHandler. Notice if the option
bridgeErrorHandler is enabled then this option is not in use. By def [...]
- "exchangePattern": { "index": 7, "kind": "parameter", "displayName":
"Exchange Pattern", "group": "consumer (advanced)", "label":
"consumer,advanced", "required": false, "type": "object", "javaType":
"org.apache.camel.ExchangePattern", "enum": [ "InOnly", "InOut" ],
"deprecated": false, "autowired": false, "secret": false, "description": "Sets
the exchange pattern when the consumer creates an exchange." },
- "mockIncludePattern": { "index": 8, "kind": "parameter", "displayName":
"Mock Include Pattern", "group": "consumer (advanced)", "label":
"consumer,advanced", "required": false, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "autowired": false, "secret": false,
"defaultValue": "classpath:camel-mock\/**", "description": "Used for inclusive
filtering of mock data from directories. The pattern is using Ant-path style
pattern. Multiple patterns can be specified sep [...]
- "restOpenapiProcessorStrategy": { "index": 9, "kind": "parameter",
"displayName": "Rest Openapi Processor Strategy", "group": "consumer
(advanced)", "label": "consumer,advanced", "required": false, "type": "object",
"javaType":
"org.apache.camel.component.rest.openapi.RestOpenapiProcessorStrategy",
"deprecated": false, "autowired": false, "secret": false, "description": "To
use a custom strategy for how to process Rest DSL requests" },
- "basePath": { "index": 10, "kind": "parameter", "displayName": "Base
Path", "group": "producer", "label": "producer", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "description": "API basePath, for example \/v3. Default
is unset, if set overrides the value present in OpenApi specification and in
the component configuration." },
- "consumes": { "index": 11, "kind": "parameter", "displayName": "Consumes",
"group": "producer", "label": "producer", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "What payload type this component capable of
consuming. Could be one type, like application\/json or multiple types as
application\/json, application\/xml; q=0.5 according to the RFC7231. This
equates to the value of Accept HTTP [...]
- "host": { "index": 12, "kind": "parameter", "displayName": "Host",
"group": "producer", "label": "producer", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "Scheme hostname and port to direct the HTTP
requests to in the form of https:\/\/hostname:port. Can be configured at the
endpoint, component or in the corresponding REST configuration in the Camel
Context. If you give this component a n [...]
- "produces": { "index": 13, "kind": "parameter", "displayName": "Produces",
"group": "producer", "label": "producer", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "What payload type this component is producing.
For example application\/json according to the RFC7231. This equates to the
value of Content-Type HTTP header. If set overrides any value present in the
OpenApi specification. Overr [...]
- "componentName": { "index": 14, "kind": "parameter", "displayName":
"Component Name", "group": "producer (advanced)", "label": "producer,advanced",
"required": false, "type": "string", "javaType": "java.lang.String",
"deprecated": false, "autowired": false, "secret": false, "description": "Name
of the Camel component that will perform the requests. The component must be
present in Camel registry and it must implement RestProducerFactory service
provider interface. If not set CLASSPAT [...]
- "lazyStartProducer": { "index": 15, "kind": "parameter", "displayName":
"Lazy Start Producer", "group": "producer (advanced)", "label":
"producer,advanced", "required": false, "type": "boolean", "javaType":
"boolean", "deprecated": false, "autowired": false, "secret": false,
"defaultValue": false, "description": "Whether the producer should be started
lazy (on the first message). By starting lazy you can use this to allow
CamelContext and routes to startup in situations where a produ [...]
- "requestValidationCustomizer": { "index": 16, "kind": "parameter",
"displayName": "Request Validation Customizer", "group": "advanced", "label":
"advanced", "required": false, "type": "object", "javaType":
"org.apache.camel.component.rest.openapi.validator.RequestValidationCustomizer",
"deprecated": false, "autowired": false, "secret": false, "description": "If
request validation is enabled, this option provides the capability to customize
the creation of OpenApiInteractionValidator [...]
- "requestValidationLevels": { "index": 17, "kind": "parameter",
"displayName": "Request Validation Levels", "group": "advanced", "label":
"advanced", "required": false, "type": "object", "javaType":
"java.util.Map<java.lang.String, java.lang.Object>", "prefix": "validation.",
"multiValue": true, "deprecated": false, "autowired": false, "secret": false,
"description": "Levels for specific OpenAPI request validation options.
Multiple options can be specified as URI options prefixed by ' [...]
+ "apiContextPath": { "index": 3, "kind": "parameter", "displayName": "Api
Context Path", "group": "consumer", "label": "consumer", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "description": "Sets the context-path to
use for servicing the OpenAPI specification" },
+ "missingOperation": { "index": 4, "kind": "parameter", "displayName":
"Missing Operation", "group": "consumer", "label": "consumer", "required":
false, "type": "string", "javaType": "java.lang.String", "enum": [ "fail",
"ignore", "mock" ], "deprecated": false, "autowired": false, "secret": false,
"defaultValue": "fail", "description": "Whether the consumer should fail,ignore
or return a mock response for OpenAPI operations that are not mapped to a
corresponding route." },
+ "bridgeErrorHandler": { "index": 5, "kind": "parameter", "displayName":
"Bridge Error Handler", "group": "consumer (advanced)", "label":
"consumer,advanced", "required": false, "type": "boolean", "javaType":
"boolean", "deprecated": false, "autowired": false, "secret": false,
"defaultValue": false, "description": "Allows for bridging the consumer to the
Camel routing Error Handler, which mean any exceptions (if possible) occurred
while the Camel consumer is trying to pickup incoming [...]
+ "consumerComponentName": { "index": 6, "kind": "parameter", "displayName":
"Consumer Component Name", "group": "consumer (advanced)", "label":
"consumer,advanced", "required": false, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "autowired": false, "secret": false,
"description": "Name of the Camel component that will service the requests. The
component must be present in Camel registry and it must implement
RestOpenApiConsumerFactory service provider interfa [...]
+ "exceptionHandler": { "index": 7, "kind": "parameter", "displayName":
"Exception Handler", "group": "consumer (advanced)", "label":
"consumer,advanced", "required": false, "type": "object", "javaType":
"org.apache.camel.spi.ExceptionHandler", "optionalPrefix": "consumer.",
"deprecated": false, "autowired": false, "secret": false, "description": "To
let the consumer use a custom ExceptionHandler. Notice if the option
bridgeErrorHandler is enabled then this option is not in use. By def [...]
+ "exchangePattern": { "index": 8, "kind": "parameter", "displayName":
"Exchange Pattern", "group": "consumer (advanced)", "label":
"consumer,advanced", "required": false, "type": "object", "javaType":
"org.apache.camel.ExchangePattern", "enum": [ "InOnly", "InOut" ],
"deprecated": false, "autowired": false, "secret": false, "description": "Sets
the exchange pattern when the consumer creates an exchange." },
+ "mockIncludePattern": { "index": 9, "kind": "parameter", "displayName":
"Mock Include Pattern", "group": "consumer (advanced)", "label":
"consumer,advanced", "required": false, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "autowired": false, "secret": false,
"defaultValue": "classpath:camel-mock\/**", "description": "Used for inclusive
filtering of mock data from directories. The pattern is using Ant-path style
pattern. Multiple patterns can be specified sep [...]
+ "restOpenapiProcessorStrategy": { "index": 10, "kind": "parameter",
"displayName": "Rest Openapi Processor Strategy", "group": "consumer
(advanced)", "label": "consumer,advanced", "required": false, "type": "object",
"javaType":
"org.apache.camel.component.rest.openapi.RestOpenapiProcessorStrategy",
"deprecated": false, "autowired": false, "secret": false, "description": "To
use a custom strategy for how to process Rest DSL requests" },
+ "basePath": { "index": 11, "kind": "parameter", "displayName": "Base
Path", "group": "producer", "label": "producer", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "description": "API basePath, for example \/v3. Default
is unset, if set overrides the value present in OpenApi specification and in
the component configuration." },
+ "consumes": { "index": 12, "kind": "parameter", "displayName": "Consumes",
"group": "producer", "label": "producer", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "What payload type this component capable of
consuming. Could be one type, like application\/json or multiple types as
application\/json, application\/xml; q=0.5 according to the RFC7231. This
equates to the value of Accept HTTP [...]
+ "host": { "index": 13, "kind": "parameter", "displayName": "Host",
"group": "producer", "label": "producer", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "Scheme hostname and port to direct the HTTP
requests to in the form of https:\/\/hostname:port. Can be configured at the
endpoint, component or in the corresponding REST configuration in the Camel
Context. If you give this component a n [...]
+ "produces": { "index": 14, "kind": "parameter", "displayName": "Produces",
"group": "producer", "label": "producer", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "What payload type this component is producing.
For example application\/json according to the RFC7231. This equates to the
value of Content-Type HTTP header. If set overrides any value present in the
OpenApi specification. Overr [...]
+ "componentName": { "index": 15, "kind": "parameter", "displayName":
"Component Name", "group": "producer (advanced)", "label": "producer,advanced",
"required": false, "type": "string", "javaType": "java.lang.String",
"deprecated": false, "autowired": false, "secret": false, "description": "Name
of the Camel component that will perform the requests. The component must be
present in Camel registry and it must implement RestProducerFactory service
provider interface. If not set CLASSPAT [...]
+ "lazyStartProducer": { "index": 16, "kind": "parameter", "displayName":
"Lazy Start Producer", "group": "producer (advanced)", "label":
"producer,advanced", "required": false, "type": "boolean", "javaType":
"boolean", "deprecated": false, "autowired": false, "secret": false,
"defaultValue": false, "description": "Whether the producer should be started
lazy (on the first message). By starting lazy you can use this to allow
CamelContext and routes to startup in situations where a produ [...]
+ "requestValidationCustomizer": { "index": 17, "kind": "parameter",
"displayName": "Request Validation Customizer", "group": "advanced", "label":
"advanced", "required": false, "type": "object", "javaType":
"org.apache.camel.component.rest.openapi.validator.RequestValidationCustomizer",
"deprecated": false, "autowired": false, "secret": false, "description": "If
request validation is enabled, this option provides the capability to customize
the creation of OpenApiInteractionValidator [...]
+ "requestValidationLevels": { "index": 18, "kind": "parameter",
"displayName": "Request Validation Levels", "group": "advanced", "label":
"advanced", "required": false, "type": "object", "javaType":
"java.util.Map<java.lang.String, java.lang.Object>", "prefix": "validation.",
"multiValue": true, "deprecated": false, "autowired": false, "secret": false,
"description": "Levels for specific OpenAPI request validation options.
Multiple options can be specified as URI options prefixed by ' [...]
}
}
diff --git
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/models/restConfiguration.json
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/models/restConfiguration.json
index 8f6eabdc526..d72d7945fc5 100644
---
a/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/models/restConfiguration.json
+++
b/catalog/camel-catalog/src/generated/resources/org/apache/camel/catalog/models/restConfiguration.json
@@ -22,7 +22,7 @@
"useXForwardHeaders": { "index": 7, "kind": "attribute", "displayName":
"Use XForward Headers", "label": "consumer,advanced", "required": false,
"type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": false, "description":
"Whether to use X-Forward headers to set host etc. for OpenApi. This may be
needed in special cases involving reverse-proxy and networking going from HTTP
to HTTPS etc. Then the proxy can send X- [...]
"producerApiDoc": { "index": 8, "kind": "attribute", "displayName":
"Producer Api Doc", "label": "producer,advanced", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "description": "Sets the location of the api document
the REST producer will use to validate the REST uri and query parameters are
valid accordingly to the api document. The location of the api document is
loaded from classpath by default, but [...]
"contextPath": { "index": 9, "kind": "attribute", "displayName": "Context
Path", "label": "consumer", "required": false, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "autowired": false, "secret": false,
"description": "Sets a leading context-path the REST services will be using.
This can be used when using components such as camel-servlet where the deployed
web application is deployed using a context-path. Or for components such as
camel-jetty or camel-netty [...]
- "apiContextPath": { "index": 10, "kind": "attribute", "displayName": "Api
Context Path", "label": "consumer", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "Sets a leading API context-path the REST API
services will be using. This can be used when using components such as
camel-servlet where the deployed web application is deployed using a
context-path." },
+ "apiContextPath": { "index": 10, "kind": "attribute", "displayName": "Api
Context Path", "label": "consumer", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "Sets a leading context-path the REST API will
be using. This can be used when using components such as camel-servlet where
the deployed web application is deployed using a context-path." },
"apiContextRouteId": { "index": 11, "kind": "attribute", "displayName":
"Api Context Route Id", "label": "consumer,advanced", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "description": "Sets the route id to use
for the route that services the REST API. The route will by default use an auto
assigned route id." },
"apiVendorExtension": { "index": 12, "kind": "attribute", "displayName":
"Api Vendor Extension", "label": "consumer,advanced", "required": false,
"type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": false, "description":
"Whether vendor extension is enabled in the Rest APIs. If enabled then Camel
will include additional information as vendor extension (eg keys starting with
x-) such as route ids, class names etc [...]
"hostNameResolver": { "index": 13, "kind": "attribute", "displayName":
"Host Name Resolver", "label": "consumer,advanced", "required": false, "type":
"enum", "javaType": "org.apache.camel.model.rest.RestHostNameResolver", "enum":
[ "allLocalIp", "localHostName", "localIp" ], "deprecated": false, "autowired":
false, "secret": false, "defaultValue": "allLocalIp", "description": "If no
hostname has been explicit configured, then this resolver is used to compute
the hostname the REST ser [...]
diff --git
a/components/camel-platform-http-vertx/src/test/java/org/apache/camel/component/platform/http/vertx/PlatformHttpRestOpenApiConsumerRestDslTest.java
b/components/camel-platform-http-vertx/src/test/java/org/apache/camel/component/platform/http/vertx/PlatformHttpRestOpenApiConsumerRestDslTest.java
index db51da21007..b836248ab33 100644
---
a/components/camel-platform-http-vertx/src/test/java/org/apache/camel/component/platform/http/vertx/PlatformHttpRestOpenApiConsumerRestDslTest.java
+++
b/components/camel-platform-http-vertx/src/test/java/org/apache/camel/component/platform/http/vertx/PlatformHttpRestOpenApiConsumerRestDslTest.java
@@ -16,8 +16,11 @@
*/
package org.apache.camel.component.platform.http.vertx;
+import java.io.FileInputStream;
+
import org.apache.camel.CamelContext;
import org.apache.camel.builder.RouteBuilder;
+import org.apache.camel.util.IOHelper;
import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.Test;
@@ -260,4 +263,46 @@ public class PlatformHttpRestOpenApiConsumerRestDslTest {
}
}
+ @Test
+ public void testRestOpenApiContextPath() throws Exception {
+ final CamelContext context =
VertxPlatformHttpEngineTest.createCamelContext();
+
+ try {
+ context.addRoutes(new RouteBuilder() {
+ @Override
+ public void configure() {
+ rest().openApi()
+ .specification("openapi-v3.json")
+ .apiContextPath("api-doc")
+ .missingOperation("ignore");
+
+ from("direct:getPetById")
+ .setBody().constant("{\"pet\": \"tony the
tiger\"}");
+ }
+ });
+
+ context.start();
+
+ given()
+ .when()
+ .get("/api/v3/pet/123")
+ .then()
+ .statusCode(200)
+ .body(equalTo("{\"pet\": \"tony the tiger\"}"));
+
+ String spec = IOHelper.loadText(new
FileInputStream("src/test/resources/openapi-v3.json"));
+
+ given()
+ .when()
+ .get("/api/v3/api-doc")
+ .then()
+ .statusCode(200)
+ .contentType("application/json")
+ .body(equalTo(spec));
+
+ } finally {
+ context.stop();
+ }
+ }
+
}
diff --git
a/components/camel-rest-openapi/src/generated/java/org/apache/camel/component/rest/openapi/RestOpenApiComponentConfigurer.java
b/components/camel-rest-openapi/src/generated/java/org/apache/camel/component/rest/openapi/RestOpenApiComponentConfigurer.java
index ee6d62376fb..5d48898caa9 100644
---
a/components/camel-rest-openapi/src/generated/java/org/apache/camel/component/rest/openapi/RestOpenApiComponentConfigurer.java
+++
b/components/camel-rest-openapi/src/generated/java/org/apache/camel/component/rest/openapi/RestOpenApiComponentConfigurer.java
@@ -21,6 +21,8 @@ public class RestOpenApiComponentConfigurer extends
PropertyConfigurerSupport im
public boolean configure(CamelContext camelContext, Object obj, String
name, Object value, boolean ignoreCase) {
RestOpenApiComponent target = (RestOpenApiComponent) obj;
switch (ignoreCase ? name.toLowerCase() : name) {
+ case "apicontextpath":
+ case "apiContextPath": target.setApiContextPath(property(camelContext,
java.lang.String.class, value)); return true;
case "autowiredenabled":
case "autowiredEnabled":
target.setAutowiredEnabled(property(camelContext, boolean.class, value));
return true;
case "basepath":
@@ -59,6 +61,8 @@ public class RestOpenApiComponentConfigurer extends
PropertyConfigurerSupport im
@Override
public Class<?> getOptionType(String name, boolean ignoreCase) {
switch (ignoreCase ? name.toLowerCase() : name) {
+ case "apicontextpath":
+ case "apiContextPath": return java.lang.String.class;
case "autowiredenabled":
case "autowiredEnabled": return boolean.class;
case "basepath":
@@ -98,6 +102,8 @@ public class RestOpenApiComponentConfigurer extends
PropertyConfigurerSupport im
public Object getOptionValue(Object obj, String name, boolean ignoreCase) {
RestOpenApiComponent target = (RestOpenApiComponent) obj;
switch (ignoreCase ? name.toLowerCase() : name) {
+ case "apicontextpath":
+ case "apiContextPath": return target.getApiContextPath();
case "autowiredenabled":
case "autowiredEnabled": return target.isAutowiredEnabled();
case "basepath":
diff --git
a/components/camel-rest-openapi/src/generated/java/org/apache/camel/component/rest/openapi/RestOpenApiEndpointConfigurer.java
b/components/camel-rest-openapi/src/generated/java/org/apache/camel/component/rest/openapi/RestOpenApiEndpointConfigurer.java
index 93eeebc6306..cdcf0df0cba 100644
---
a/components/camel-rest-openapi/src/generated/java/org/apache/camel/component/rest/openapi/RestOpenApiEndpointConfigurer.java
+++
b/components/camel-rest-openapi/src/generated/java/org/apache/camel/component/rest/openapi/RestOpenApiEndpointConfigurer.java
@@ -21,6 +21,8 @@ public class RestOpenApiEndpointConfigurer extends
PropertyConfigurerSupport imp
public boolean configure(CamelContext camelContext, Object obj, String
name, Object value, boolean ignoreCase) {
RestOpenApiEndpoint target = (RestOpenApiEndpoint) obj;
switch (ignoreCase ? name.toLowerCase() : name) {
+ case "apicontextpath":
+ case "apiContextPath": target.setApiContextPath(property(camelContext,
java.lang.String.class, value)); return true;
case "basepath":
case "basePath": target.setBasePath(property(camelContext,
java.lang.String.class, value)); return true;
case "bridgeerrorhandler":
@@ -57,6 +59,8 @@ public class RestOpenApiEndpointConfigurer extends
PropertyConfigurerSupport imp
@Override
public Class<?> getOptionType(String name, boolean ignoreCase) {
switch (ignoreCase ? name.toLowerCase() : name) {
+ case "apicontextpath":
+ case "apiContextPath": return java.lang.String.class;
case "basepath":
case "basePath": return java.lang.String.class;
case "bridgeerrorhandler":
@@ -94,6 +98,8 @@ public class RestOpenApiEndpointConfigurer extends
PropertyConfigurerSupport imp
public Object getOptionValue(Object obj, String name, boolean ignoreCase) {
RestOpenApiEndpoint target = (RestOpenApiEndpoint) obj;
switch (ignoreCase ? name.toLowerCase() : name) {
+ case "apicontextpath":
+ case "apiContextPath": return target.getApiContextPath();
case "basepath":
case "basePath": return target.getBasePath();
case "bridgeerrorhandler":
diff --git
a/components/camel-rest-openapi/src/generated/java/org/apache/camel/component/rest/openapi/RestOpenApiEndpointUriFactory.java
b/components/camel-rest-openapi/src/generated/java/org/apache/camel/component/rest/openapi/RestOpenApiEndpointUriFactory.java
index 1f4cda596a6..5831306e28b 100644
---
a/components/camel-rest-openapi/src/generated/java/org/apache/camel/component/rest/openapi/RestOpenApiEndpointUriFactory.java
+++
b/components/camel-rest-openapi/src/generated/java/org/apache/camel/component/rest/openapi/RestOpenApiEndpointUriFactory.java
@@ -21,7 +21,8 @@ public class RestOpenApiEndpointUriFactory extends
org.apache.camel.support.comp
private static final Set<String> SECRET_PROPERTY_NAMES;
private static final Set<String> MULTI_VALUE_PREFIXES;
static {
- Set<String> props = new HashSet<>(18);
+ Set<String> props = new HashSet<>(19);
+ props.add("apiContextPath");
props.add("basePath");
props.add("bridgeErrorHandler");
props.add("componentName");
diff --git
a/components/camel-rest-openapi/src/generated/resources/META-INF/org/apache/camel/component/rest/openapi/rest-openapi.json
b/components/camel-rest-openapi/src/generated/resources/META-INF/org/apache/camel/component/rest/openapi/rest-openapi.json
index a2f378c6e67..7c83b6b9cb4 100644
---
a/components/camel-rest-openapi/src/generated/resources/META-INF/org/apache/camel/component/rest/openapi/rest-openapi.json
+++
b/components/camel-rest-openapi/src/generated/resources/META-INF/org/apache/camel/component/rest/openapi/rest-openapi.json
@@ -27,38 +27,40 @@
"requestValidationEnabled": { "index": 1, "kind": "property",
"displayName": "Request Validation Enabled", "group": "common", "label":
"common", "required": false, "type": "boolean", "javaType": "boolean",
"deprecated": false, "autowired": false, "secret": false, "defaultValue":
false, "description": "Enable validation of requests against the configured
OpenAPI specification" },
"specificationUri": { "index": 2, "kind": "property", "displayName":
"Specification Uri", "group": "common", "label": "common", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": "openapi.json",
"description": "Path to the OpenApi specification file. The scheme, host base
path are taken from this specification, but these can be overridden with
properties on the component or endpoint level. If [...]
"requestValidationCustomizer": { "index": 3, "kind": "property",
"displayName": "Request Validation Customizer", "group": "common (advanced)",
"label": "common,advanced", "required": false, "type": "object", "javaType":
"org.apache.camel.component.rest.openapi.validator.RequestValidationCustomizer",
"deprecated": false, "autowired": false, "secret": false, "description": "If
request validation is enabled, this option provides the capability to customize
the creation of OpenApiInterac [...]
- "bridgeErrorHandler": { "index": 4, "kind": "property", "displayName":
"Bridge Error Handler", "group": "consumer", "label": "consumer", "required":
false, "type": "boolean", "javaType": "boolean", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": false, "description":
"Allows for bridging the consumer to the Camel routing Error Handler, which
mean any exceptions (if possible) occurred while the Camel consumer is trying
to pickup incoming messages, or the like [...]
- "missingOperation": { "index": 5, "kind": "property", "displayName":
"Missing Operation", "group": "consumer", "label": "consumer", "required":
false, "type": "string", "javaType": "java.lang.String", "enum": [ "fail",
"ignore", "mock" ], "deprecated": false, "autowired": false, "secret": false,
"defaultValue": "fail", "description": "Whether the consumer should fail,ignore
or return a mock response for OpenAPI operations that are not mapped to a
corresponding route." },
- "consumerComponentName": { "index": 6, "kind": "property", "displayName":
"Consumer Component Name", "group": "consumer (advanced)", "label":
"consumer,advanced", "required": false, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "autowired": false, "secret": false,
"description": "Name of the Camel component that will service the requests. The
component must be present in Camel registry and it must implement
RestOpenApiConsumerFactory service provider interfac [...]
- "mockIncludePattern": { "index": 7, "kind": "property", "displayName":
"Mock Include Pattern", "group": "consumer (advanced)", "label":
"consumer,advanced", "required": false, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "autowired": false, "secret": false,
"defaultValue": "classpath:camel-mock\/**", "description": "Used for inclusive
filtering of mock data from directories. The pattern is using Ant-path style
pattern. Multiple patterns can be specified sepa [...]
- "restOpenapiProcessorStrategy": { "index": 8, "kind": "property",
"displayName": "Rest Openapi Processor Strategy", "group": "consumer
(advanced)", "label": "consumer,advanced", "required": false, "type": "object",
"javaType":
"org.apache.camel.component.rest.openapi.RestOpenapiProcessorStrategy",
"deprecated": false, "autowired": false, "secret": false, "description": "To
use a custom strategy for how to process Rest DSL requests" },
- "host": { "index": 9, "kind": "property", "displayName": "Host", "group":
"producer", "label": "producer", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "Scheme hostname and port to direct the HTTP
requests to in the form of https:\/\/hostname:port. Can be configured at the
endpoint, component or in the corresponding REST configuration in the Camel
Context. If you give this component a nam [...]
- "lazyStartProducer": { "index": 10, "kind": "property", "displayName":
"Lazy Start Producer", "group": "producer", "label": "producer", "required":
false, "type": "boolean", "javaType": "boolean", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": false, "description":
"Whether the producer should be started lazy (on the first message). By
starting lazy you can use this to allow CamelContext and routes to startup in
situations where a producer may otherwise fai [...]
- "componentName": { "index": 11, "kind": "property", "displayName":
"Component Name", "group": "producer (advanced)", "label": "producer,advanced",
"required": false, "type": "string", "javaType": "java.lang.String",
"deprecated": false, "autowired": false, "secret": false, "description": "Name
of the Camel component that will perform the requests. The component must be
present in Camel registry and it must implement RestProducerFactory service
provider interface. If not set CLASSPATH [...]
- "consumes": { "index": 12, "kind": "property", "displayName": "Consumes",
"group": "producer (advanced)", "label": "producer,advanced", "required":
false, "type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "description": "What payload type this
component capable of consuming. Could be one type, like application\/json or
multiple types as application\/json, application\/xml; q=0.5 according to the
RFC7231. This equates to the va [...]
- "produces": { "index": 13, "kind": "property", "displayName": "Produces",
"group": "producer (advanced)", "label": "producer,advanced", "required":
false, "type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "description": "What payload type this
component is producing. For example application\/json according to the RFC7231.
This equates to the value of Content-Type HTTP header. If set overrides any
value present in the OpenApi s [...]
- "autowiredEnabled": { "index": 14, "kind": "property", "displayName":
"Autowired Enabled", "group": "advanced", "label": "advanced", "required":
false, "type": "boolean", "javaType": "boolean", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": true, "description":
"Whether autowiring is enabled. This is used for automatic autowiring options
(the option must be marked as autowired) by looking up in the registry to find
if there is a single instance of matching [...]
- "sslContextParameters": { "index": 15, "kind": "property", "displayName":
"Ssl Context Parameters", "group": "security", "label": "security", "required":
false, "type": "object", "javaType":
"org.apache.camel.support.jsse.SSLContextParameters", "deprecated": false,
"autowired": false, "secret": false, "description": "Customize TLS parameters
used by the component. If not set defaults to the TLS parameters set in the
Camel context" },
- "useGlobalSslContextParameters": { "index": 16, "kind": "property",
"displayName": "Use Global Ssl Context Parameters", "group": "security",
"label": "security", "required": false, "type": "boolean", "javaType":
"boolean", "deprecated": false, "autowired": false, "secret": false,
"defaultValue": false, "description": "Enable usage of global SSL context
parameters." }
+ "apiContextPath": { "index": 4, "kind": "property", "displayName": "Api
Context Path", "group": "consumer", "label": "consumer", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "description": "Sets the context-path to
use for servicing the OpenAPI specification" },
+ "bridgeErrorHandler": { "index": 5, "kind": "property", "displayName":
"Bridge Error Handler", "group": "consumer", "label": "consumer", "required":
false, "type": "boolean", "javaType": "boolean", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": false, "description":
"Allows for bridging the consumer to the Camel routing Error Handler, which
mean any exceptions (if possible) occurred while the Camel consumer is trying
to pickup incoming messages, or the like [...]
+ "missingOperation": { "index": 6, "kind": "property", "displayName":
"Missing Operation", "group": "consumer", "label": "consumer", "required":
false, "type": "string", "javaType": "java.lang.String", "enum": [ "fail",
"ignore", "mock" ], "deprecated": false, "autowired": false, "secret": false,
"defaultValue": "fail", "description": "Whether the consumer should fail,ignore
or return a mock response for OpenAPI operations that are not mapped to a
corresponding route." },
+ "consumerComponentName": { "index": 7, "kind": "property", "displayName":
"Consumer Component Name", "group": "consumer (advanced)", "label":
"consumer,advanced", "required": false, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "autowired": false, "secret": false,
"description": "Name of the Camel component that will service the requests. The
component must be present in Camel registry and it must implement
RestOpenApiConsumerFactory service provider interfac [...]
+ "mockIncludePattern": { "index": 8, "kind": "property", "displayName":
"Mock Include Pattern", "group": "consumer (advanced)", "label":
"consumer,advanced", "required": false, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "autowired": false, "secret": false,
"defaultValue": "classpath:camel-mock\/**", "description": "Used for inclusive
filtering of mock data from directories. The pattern is using Ant-path style
pattern. Multiple patterns can be specified sepa [...]
+ "restOpenapiProcessorStrategy": { "index": 9, "kind": "property",
"displayName": "Rest Openapi Processor Strategy", "group": "consumer
(advanced)", "label": "consumer,advanced", "required": false, "type": "object",
"javaType":
"org.apache.camel.component.rest.openapi.RestOpenapiProcessorStrategy",
"deprecated": false, "autowired": false, "secret": false, "description": "To
use a custom strategy for how to process Rest DSL requests" },
+ "host": { "index": 10, "kind": "property", "displayName": "Host", "group":
"producer", "label": "producer", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "Scheme hostname and port to direct the HTTP
requests to in the form of https:\/\/hostname:port. Can be configured at the
endpoint, component or in the corresponding REST configuration in the Camel
Context. If you give this component a na [...]
+ "lazyStartProducer": { "index": 11, "kind": "property", "displayName":
"Lazy Start Producer", "group": "producer", "label": "producer", "required":
false, "type": "boolean", "javaType": "boolean", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": false, "description":
"Whether the producer should be started lazy (on the first message). By
starting lazy you can use this to allow CamelContext and routes to startup in
situations where a producer may otherwise fai [...]
+ "componentName": { "index": 12, "kind": "property", "displayName":
"Component Name", "group": "producer (advanced)", "label": "producer,advanced",
"required": false, "type": "string", "javaType": "java.lang.String",
"deprecated": false, "autowired": false, "secret": false, "description": "Name
of the Camel component that will perform the requests. The component must be
present in Camel registry and it must implement RestProducerFactory service
provider interface. If not set CLASSPATH [...]
+ "consumes": { "index": 13, "kind": "property", "displayName": "Consumes",
"group": "producer (advanced)", "label": "producer,advanced", "required":
false, "type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "description": "What payload type this
component capable of consuming. Could be one type, like application\/json or
multiple types as application\/json, application\/xml; q=0.5 according to the
RFC7231. This equates to the va [...]
+ "produces": { "index": 14, "kind": "property", "displayName": "Produces",
"group": "producer (advanced)", "label": "producer,advanced", "required":
false, "type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "description": "What payload type this
component is producing. For example application\/json according to the RFC7231.
This equates to the value of Content-Type HTTP header. If set overrides any
value present in the OpenApi s [...]
+ "autowiredEnabled": { "index": 15, "kind": "property", "displayName":
"Autowired Enabled", "group": "advanced", "label": "advanced", "required":
false, "type": "boolean", "javaType": "boolean", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": true, "description":
"Whether autowiring is enabled. This is used for automatic autowiring options
(the option must be marked as autowired) by looking up in the registry to find
if there is a single instance of matching [...]
+ "sslContextParameters": { "index": 16, "kind": "property", "displayName":
"Ssl Context Parameters", "group": "security", "label": "security", "required":
false, "type": "object", "javaType":
"org.apache.camel.support.jsse.SSLContextParameters", "deprecated": false,
"autowired": false, "secret": false, "description": "Customize TLS parameters
used by the component. If not set defaults to the TLS parameters set in the
Camel context" },
+ "useGlobalSslContextParameters": { "index": 17, "kind": "property",
"displayName": "Use Global Ssl Context Parameters", "group": "security",
"label": "security", "required": false, "type": "boolean", "javaType":
"boolean", "deprecated": false, "autowired": false, "secret": false,
"defaultValue": false, "description": "Enable usage of global SSL context
parameters." }
},
"properties": {
"specificationUri": { "index": 0, "kind": "path", "displayName":
"Specification Uri", "group": "common", "label": "common", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": "openapi.json",
"description": "Path to the OpenApi specification file. The scheme, host base
path are taken from this specification, but these can be overridden with
properties on the component or endpoint level. If not [...]
"operationId": { "index": 1, "kind": "path", "displayName": "Operation
Id", "group": "producer", "label": "producer", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "description": "ID of the operation from the OpenApi
specification. This is required when using producer" },
"requestValidationEnabled": { "index": 2, "kind": "parameter",
"displayName": "Request Validation Enabled", "group": "common", "label": "",
"required": false, "type": "boolean", "javaType": "boolean", "deprecated":
false, "autowired": false, "secret": false, "defaultValue": false,
"description": "Enable validation of requests against the configured OpenAPI
specification" },
- "missingOperation": { "index": 3, "kind": "parameter", "displayName":
"Missing Operation", "group": "consumer", "label": "consumer", "required":
false, "type": "string", "javaType": "java.lang.String", "enum": [ "fail",
"ignore", "mock" ], "deprecated": false, "autowired": false, "secret": false,
"defaultValue": "fail", "description": "Whether the consumer should fail,ignore
or return a mock response for OpenAPI operations that are not mapped to a
corresponding route." },
- "bridgeErrorHandler": { "index": 4, "kind": "parameter", "displayName":
"Bridge Error Handler", "group": "consumer (advanced)", "label":
"consumer,advanced", "required": false, "type": "boolean", "javaType":
"boolean", "deprecated": false, "autowired": false, "secret": false,
"defaultValue": false, "description": "Allows for bridging the consumer to the
Camel routing Error Handler, which mean any exceptions (if possible) occurred
while the Camel consumer is trying to pickup incoming [...]
- "consumerComponentName": { "index": 5, "kind": "parameter", "displayName":
"Consumer Component Name", "group": "consumer (advanced)", "label":
"consumer,advanced", "required": false, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "autowired": false, "secret": false,
"description": "Name of the Camel component that will service the requests. The
component must be present in Camel registry and it must implement
RestOpenApiConsumerFactory service provider interfa [...]
- "exceptionHandler": { "index": 6, "kind": "parameter", "displayName":
"Exception Handler", "group": "consumer (advanced)", "label":
"consumer,advanced", "required": false, "type": "object", "javaType":
"org.apache.camel.spi.ExceptionHandler", "optionalPrefix": "consumer.",
"deprecated": false, "autowired": false, "secret": false, "description": "To
let the consumer use a custom ExceptionHandler. Notice if the option
bridgeErrorHandler is enabled then this option is not in use. By def [...]
- "exchangePattern": { "index": 7, "kind": "parameter", "displayName":
"Exchange Pattern", "group": "consumer (advanced)", "label":
"consumer,advanced", "required": false, "type": "object", "javaType":
"org.apache.camel.ExchangePattern", "enum": [ "InOnly", "InOut" ],
"deprecated": false, "autowired": false, "secret": false, "description": "Sets
the exchange pattern when the consumer creates an exchange." },
- "mockIncludePattern": { "index": 8, "kind": "parameter", "displayName":
"Mock Include Pattern", "group": "consumer (advanced)", "label":
"consumer,advanced", "required": false, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "autowired": false, "secret": false,
"defaultValue": "classpath:camel-mock\/**", "description": "Used for inclusive
filtering of mock data from directories. The pattern is using Ant-path style
pattern. Multiple patterns can be specified sep [...]
- "restOpenapiProcessorStrategy": { "index": 9, "kind": "parameter",
"displayName": "Rest Openapi Processor Strategy", "group": "consumer
(advanced)", "label": "consumer,advanced", "required": false, "type": "object",
"javaType":
"org.apache.camel.component.rest.openapi.RestOpenapiProcessorStrategy",
"deprecated": false, "autowired": false, "secret": false, "description": "To
use a custom strategy for how to process Rest DSL requests" },
- "basePath": { "index": 10, "kind": "parameter", "displayName": "Base
Path", "group": "producer", "label": "producer", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "description": "API basePath, for example \/v3. Default
is unset, if set overrides the value present in OpenApi specification and in
the component configuration." },
- "consumes": { "index": 11, "kind": "parameter", "displayName": "Consumes",
"group": "producer", "label": "producer", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "What payload type this component capable of
consuming. Could be one type, like application\/json or multiple types as
application\/json, application\/xml; q=0.5 according to the RFC7231. This
equates to the value of Accept HTTP [...]
- "host": { "index": 12, "kind": "parameter", "displayName": "Host",
"group": "producer", "label": "producer", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "Scheme hostname and port to direct the HTTP
requests to in the form of https:\/\/hostname:port. Can be configured at the
endpoint, component or in the corresponding REST configuration in the Camel
Context. If you give this component a n [...]
- "produces": { "index": 13, "kind": "parameter", "displayName": "Produces",
"group": "producer", "label": "producer", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "What payload type this component is producing.
For example application\/json according to the RFC7231. This equates to the
value of Content-Type HTTP header. If set overrides any value present in the
OpenApi specification. Overr [...]
- "componentName": { "index": 14, "kind": "parameter", "displayName":
"Component Name", "group": "producer (advanced)", "label": "producer,advanced",
"required": false, "type": "string", "javaType": "java.lang.String",
"deprecated": false, "autowired": false, "secret": false, "description": "Name
of the Camel component that will perform the requests. The component must be
present in Camel registry and it must implement RestProducerFactory service
provider interface. If not set CLASSPAT [...]
- "lazyStartProducer": { "index": 15, "kind": "parameter", "displayName":
"Lazy Start Producer", "group": "producer (advanced)", "label":
"producer,advanced", "required": false, "type": "boolean", "javaType":
"boolean", "deprecated": false, "autowired": false, "secret": false,
"defaultValue": false, "description": "Whether the producer should be started
lazy (on the first message). By starting lazy you can use this to allow
CamelContext and routes to startup in situations where a produ [...]
- "requestValidationCustomizer": { "index": 16, "kind": "parameter",
"displayName": "Request Validation Customizer", "group": "advanced", "label":
"advanced", "required": false, "type": "object", "javaType":
"org.apache.camel.component.rest.openapi.validator.RequestValidationCustomizer",
"deprecated": false, "autowired": false, "secret": false, "description": "If
request validation is enabled, this option provides the capability to customize
the creation of OpenApiInteractionValidator [...]
- "requestValidationLevels": { "index": 17, "kind": "parameter",
"displayName": "Request Validation Levels", "group": "advanced", "label":
"advanced", "required": false, "type": "object", "javaType":
"java.util.Map<java.lang.String, java.lang.Object>", "prefix": "validation.",
"multiValue": true, "deprecated": false, "autowired": false, "secret": false,
"description": "Levels for specific OpenAPI request validation options.
Multiple options can be specified as URI options prefixed by ' [...]
+ "apiContextPath": { "index": 3, "kind": "parameter", "displayName": "Api
Context Path", "group": "consumer", "label": "consumer", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "description": "Sets the context-path to
use for servicing the OpenAPI specification" },
+ "missingOperation": { "index": 4, "kind": "parameter", "displayName":
"Missing Operation", "group": "consumer", "label": "consumer", "required":
false, "type": "string", "javaType": "java.lang.String", "enum": [ "fail",
"ignore", "mock" ], "deprecated": false, "autowired": false, "secret": false,
"defaultValue": "fail", "description": "Whether the consumer should fail,ignore
or return a mock response for OpenAPI operations that are not mapped to a
corresponding route." },
+ "bridgeErrorHandler": { "index": 5, "kind": "parameter", "displayName":
"Bridge Error Handler", "group": "consumer (advanced)", "label":
"consumer,advanced", "required": false, "type": "boolean", "javaType":
"boolean", "deprecated": false, "autowired": false, "secret": false,
"defaultValue": false, "description": "Allows for bridging the consumer to the
Camel routing Error Handler, which mean any exceptions (if possible) occurred
while the Camel consumer is trying to pickup incoming [...]
+ "consumerComponentName": { "index": 6, "kind": "parameter", "displayName":
"Consumer Component Name", "group": "consumer (advanced)", "label":
"consumer,advanced", "required": false, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "autowired": false, "secret": false,
"description": "Name of the Camel component that will service the requests. The
component must be present in Camel registry and it must implement
RestOpenApiConsumerFactory service provider interfa [...]
+ "exceptionHandler": { "index": 7, "kind": "parameter", "displayName":
"Exception Handler", "group": "consumer (advanced)", "label":
"consumer,advanced", "required": false, "type": "object", "javaType":
"org.apache.camel.spi.ExceptionHandler", "optionalPrefix": "consumer.",
"deprecated": false, "autowired": false, "secret": false, "description": "To
let the consumer use a custom ExceptionHandler. Notice if the option
bridgeErrorHandler is enabled then this option is not in use. By def [...]
+ "exchangePattern": { "index": 8, "kind": "parameter", "displayName":
"Exchange Pattern", "group": "consumer (advanced)", "label":
"consumer,advanced", "required": false, "type": "object", "javaType":
"org.apache.camel.ExchangePattern", "enum": [ "InOnly", "InOut" ],
"deprecated": false, "autowired": false, "secret": false, "description": "Sets
the exchange pattern when the consumer creates an exchange." },
+ "mockIncludePattern": { "index": 9, "kind": "parameter", "displayName":
"Mock Include Pattern", "group": "consumer (advanced)", "label":
"consumer,advanced", "required": false, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "autowired": false, "secret": false,
"defaultValue": "classpath:camel-mock\/**", "description": "Used for inclusive
filtering of mock data from directories. The pattern is using Ant-path style
pattern. Multiple patterns can be specified sep [...]
+ "restOpenapiProcessorStrategy": { "index": 10, "kind": "parameter",
"displayName": "Rest Openapi Processor Strategy", "group": "consumer
(advanced)", "label": "consumer,advanced", "required": false, "type": "object",
"javaType":
"org.apache.camel.component.rest.openapi.RestOpenapiProcessorStrategy",
"deprecated": false, "autowired": false, "secret": false, "description": "To
use a custom strategy for how to process Rest DSL requests" },
+ "basePath": { "index": 11, "kind": "parameter", "displayName": "Base
Path", "group": "producer", "label": "producer", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "description": "API basePath, for example \/v3. Default
is unset, if set overrides the value present in OpenApi specification and in
the component configuration." },
+ "consumes": { "index": 12, "kind": "parameter", "displayName": "Consumes",
"group": "producer", "label": "producer", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "What payload type this component capable of
consuming. Could be one type, like application\/json or multiple types as
application\/json, application\/xml; q=0.5 according to the RFC7231. This
equates to the value of Accept HTTP [...]
+ "host": { "index": 13, "kind": "parameter", "displayName": "Host",
"group": "producer", "label": "producer", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "Scheme hostname and port to direct the HTTP
requests to in the form of https:\/\/hostname:port. Can be configured at the
endpoint, component or in the corresponding REST configuration in the Camel
Context. If you give this component a n [...]
+ "produces": { "index": 14, "kind": "parameter", "displayName": "Produces",
"group": "producer", "label": "producer", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "What payload type this component is producing.
For example application\/json according to the RFC7231. This equates to the
value of Content-Type HTTP header. If set overrides any value present in the
OpenApi specification. Overr [...]
+ "componentName": { "index": 15, "kind": "parameter", "displayName":
"Component Name", "group": "producer (advanced)", "label": "producer,advanced",
"required": false, "type": "string", "javaType": "java.lang.String",
"deprecated": false, "autowired": false, "secret": false, "description": "Name
of the Camel component that will perform the requests. The component must be
present in Camel registry and it must implement RestProducerFactory service
provider interface. If not set CLASSPAT [...]
+ "lazyStartProducer": { "index": 16, "kind": "parameter", "displayName":
"Lazy Start Producer", "group": "producer (advanced)", "label":
"producer,advanced", "required": false, "type": "boolean", "javaType":
"boolean", "deprecated": false, "autowired": false, "secret": false,
"defaultValue": false, "description": "Whether the producer should be started
lazy (on the first message). By starting lazy you can use this to allow
CamelContext and routes to startup in situations where a produ [...]
+ "requestValidationCustomizer": { "index": 17, "kind": "parameter",
"displayName": "Request Validation Customizer", "group": "advanced", "label":
"advanced", "required": false, "type": "object", "javaType":
"org.apache.camel.component.rest.openapi.validator.RequestValidationCustomizer",
"deprecated": false, "autowired": false, "secret": false, "description": "If
request validation is enabled, this option provides the capability to customize
the creation of OpenApiInteractionValidator [...]
+ "requestValidationLevels": { "index": 18, "kind": "parameter",
"displayName": "Request Validation Levels", "group": "advanced", "label":
"advanced", "required": false, "type": "object", "javaType":
"java.util.Map<java.lang.String, java.lang.Object>", "prefix": "validation.",
"multiValue": true, "deprecated": false, "autowired": false, "secret": false,
"description": "Levels for specific OpenAPI request validation options.
Multiple options can be specified as URI options prefixed by ' [...]
}
}
diff --git
a/components/camel-rest-openapi/src/main/java/org/apache/camel/component/rest/openapi/DefaultRestOpenapiProcessorStrategy.java
b/components/camel-rest-openapi/src/main/java/org/apache/camel/component/rest/openapi/DefaultRestOpenapiProcessorStrategy.java
index 0ac3b7de488..c23cde28873 100644
---
a/components/camel-rest-openapi/src/main/java/org/apache/camel/component/rest/openapi/DefaultRestOpenapiProcessorStrategy.java
+++
b/components/camel-rest-openapi/src/main/java/org/apache/camel/component/rest/openapi/DefaultRestOpenapiProcessorStrategy.java
@@ -16,6 +16,7 @@
*/
package org.apache.camel.component.rest.openapi;
+import java.io.InputStream;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
@@ -61,6 +62,7 @@ public class DefaultRestOpenapiProcessorStrategy extends
ServiceSupport
private String component = "direct";
private String missingOperation;
private String mockIncludePattern;
+ private String apiContextPath;
private final List<String> uris = new ArrayList<>();
@Override
@@ -137,6 +139,28 @@ public class DefaultRestOpenapiProcessorStrategy extends
ServiceSupport
}
}
+ @Override
+ public boolean processApiSpecification(String specificationUri, Exchange
exchange, AsyncCallback callback) {
+ try {
+ Resource res =
PluginHelper.getResourceLoader(camelContext).resolveResource(specificationUri);
+ if (res != null && res.exists()) {
+ if (specificationUri.endsWith("json")) {
+ exchange.getMessage().setHeader(Exchange.CONTENT_TYPE,
"application/json");
+ } else if (specificationUri.endsWith("yaml") ||
specificationUri.endsWith("yml")) {
+ exchange.getMessage().setHeader(Exchange.CONTENT_TYPE,
"text/yaml");
+ }
+ InputStream is = res.getInputStream();
+ String data = IOHelper.loadText(is);
+ exchange.getMessage().setBody(data);
+ IOHelper.close(is);
+ }
+ } catch (Exception e) {
+ exchange.setException(e);
+ }
+ callback.done(true);
+ return true;
+ }
+
@Override
public boolean process(Operation operation, String path, Exchange
exchange, AsyncCallback callback) {
if ("mock".equalsIgnoreCase(missingOperation)) {
@@ -256,6 +280,14 @@ public class DefaultRestOpenapiProcessorStrategy extends
ServiceSupport
this.mockIncludePattern = mockIncludePattern;
}
+ public String getApiContextPath() {
+ return apiContextPath;
+ }
+
+ public void setApiContextPath(String apiContextPath) {
+ this.apiContextPath = apiContextPath;
+ }
+
@Override
protected void doInit() throws Exception {
producerCache = new DefaultProducerCache(this, getCamelContext(),
1000);
diff --git
a/components/camel-rest-openapi/src/main/java/org/apache/camel/component/rest/openapi/RestOpenApiComponent.java
b/components/camel-rest-openapi/src/main/java/org/apache/camel/component/rest/openapi/RestOpenApiComponent.java
index fc69ee65ecf..d9eb5b17925 100644
---
a/components/camel-rest-openapi/src/main/java/org/apache/camel/component/rest/openapi/RestOpenApiComponent.java
+++
b/components/camel-rest-openapi/src/main/java/org/apache/camel/component/rest/openapi/RestOpenApiComponent.java
@@ -137,6 +137,8 @@ public final class RestOpenApiComponent extends
DefaultComponent implements SSLC
+ " Multiple patterns can be specified separated
by comma.",
label = "consumer,advanced", defaultValue =
"classpath:camel-mock/**")
private String mockIncludePattern = "classpath:camel-mock/**";
+ @Metadata(label = "consumer", description = "Sets the context-path to use
for servicing the OpenAPI specification")
+ private String apiContextPath;
@Metadata(description = "To use a custom strategy for how to process Rest
DSL requests", label = "consumer,advanced")
private RestOpenapiProcessorStrategy restOpenapiProcessorStrategy = new
DefaultRestOpenapiProcessorStrategy();
@Metadata(description = "Enable usage of global SSL context parameters.",
label = "security")
@@ -156,6 +158,7 @@ public final class RestOpenApiComponent extends
DefaultComponent implements SSLC
protected Endpoint createEndpoint(final String uri, final String
remaining, final Map<String, Object> parameters)
throws Exception {
RestOpenApiEndpoint endpoint = new RestOpenApiEndpoint(uri, remaining,
this, parameters);
+ endpoint.setApiContextPath(getApiContextPath());
endpoint.setRequestValidationCustomizer(getRequestValidationCustomizer());
endpoint.setRequestValidationEnabled(isRequestValidationEnabled());
endpoint.setRequestValidationLevels(PropertiesHelper.extractProperties(parameters,
"validation."));
@@ -227,6 +230,14 @@ public final class RestOpenApiComponent extends
DefaultComponent implements SSLC
this.mockIncludePattern = mockIncludePattern;
}
+ public String getApiContextPath() {
+ return apiContextPath;
+ }
+
+ public void setApiContextPath(String apiContextPath) {
+ this.apiContextPath = apiContextPath;
+ }
+
public void setBasePath(final String basePath) {
this.basePath = notEmpty(basePath, "basePath");
}
diff --git
a/components/camel-rest-openapi/src/main/java/org/apache/camel/component/rest/openapi/RestOpenApiEndpoint.java
b/components/camel-rest-openapi/src/main/java/org/apache/camel/component/rest/openapi/RestOpenApiEndpoint.java
index 0ef9aa3703e..0a29a7c18b5 100644
---
a/components/camel-rest-openapi/src/main/java/org/apache/camel/component/rest/openapi/RestOpenApiEndpoint.java
+++
b/components/camel-rest-openapi/src/main/java/org/apache/camel/component/rest/openapi/RestOpenApiEndpoint.java
@@ -171,6 +171,8 @@ public final class RestOpenApiEndpoint extends
DefaultEndpoint {
+ " Multiple patterns can be specified separated
by comma.",
label = "consumer,advanced", defaultValue =
"classpath:camel-mock/**")
private String mockIncludePattern;
+ @UriParam(label = "consumer", description = "Sets the context-path to use
for servicing the OpenAPI specification")
+ private String apiContextPath;
public RestOpenApiEndpoint() {
// help tooling instantiate endpoint
@@ -211,7 +213,7 @@ public final class RestOpenApiEndpoint extends
DefaultEndpoint {
public Consumer createConsumer(final Processor processor) throws Exception
{
OpenAPI doc = loadSpecificationFrom(getCamelContext(),
specificationUri);
String path = determineBasePath(doc);
- Processor target = new RestOpenApiProcessor(this, doc, path,
processor, restOpenapiProcessorStrategy);
+ Processor target = new RestOpenApiProcessor(this, doc, path,
apiContextPath, processor, restOpenapiProcessorStrategy);
CamelContextAware.trySetCamelContext(target, getCamelContext());
return createConsumerFor(path, target);
}
@@ -468,6 +470,14 @@ public final class RestOpenApiEndpoint extends
DefaultEndpoint {
return mockIncludePattern;
}
+ public String getApiContextPath() {
+ return apiContextPath;
+ }
+
+ public void setApiContextPath(String apiContextPath) {
+ this.apiContextPath = apiContextPath;
+ }
+
Producer createProducerFor(
final OpenAPI openapi, final Operation operation, final String
method,
final String uriTemplate)
diff --git
a/components/camel-rest-openapi/src/main/java/org/apache/camel/component/rest/openapi/RestOpenApiProcessor.java
b/components/camel-rest-openapi/src/main/java/org/apache/camel/component/rest/openapi/RestOpenApiProcessor.java
index 429b01dcd4b..44bbbce008d 100644
---
a/components/camel-rest-openapi/src/main/java/org/apache/camel/component/rest/openapi/RestOpenApiProcessor.java
+++
b/components/camel-rest-openapi/src/main/java/org/apache/camel/component/rest/openapi/RestOpenApiProcessor.java
@@ -47,14 +47,17 @@ public class RestOpenApiProcessor extends
DelegateAsyncProcessor implements Came
private final RestOpenApiEndpoint endpoint;
private final OpenAPI openAPI;
private final String basePath;
+ private final String apiContextPath;
private final List<RestConsumerContextPathMatcher.ConsumerPath<Operation>>
paths = new ArrayList<>();
private final RestOpenapiProcessorStrategy restOpenapiProcessorStrategy;
- public RestOpenApiProcessor(RestOpenApiEndpoint endpoint, OpenAPI openAPI,
String basePath, Processor processor,
- RestOpenapiProcessorStrategy
restOpenapiProcessorStrategy) {
+ public RestOpenApiProcessor(RestOpenApiEndpoint endpoint, OpenAPI openAPI,
String basePath, String apiContextPath,
+ Processor processor,
RestOpenapiProcessorStrategy restOpenapiProcessorStrategy) {
super(processor);
this.endpoint = endpoint;
this.basePath = basePath;
+ // ensure starts with leading slash
+ this.apiContextPath = apiContextPath != null &&
!apiContextPath.startsWith("/") ? "/" + apiContextPath : apiContextPath;
this.openAPI = openAPI;
this.restOpenapiProcessorStrategy = restOpenapiProcessorStrategy;
}
@@ -115,6 +118,11 @@ public class RestOpenApiProcessor extends
DelegateAsyncProcessor implements Came
return restOpenapiProcessorStrategy.process(operation, path,
exchange, callback);
}
+ // is it the api-context path
+ if (path != null && path.equals(apiContextPath)) {
+ return
restOpenapiProcessorStrategy.processApiSpecification(endpoint.getSpecificationUri(),
exchange, callback);
+ }
+
// okay we cannot process this requires so return either 404 or 405.
// to know if its 405 then we need to check if any other HTTP method
would have a consumer for the "same" request
final String contextPath = path;
diff --git
a/components/camel-rest-openapi/src/main/java/org/apache/camel/component/rest/openapi/RestOpenapiProcessorStrategy.java
b/components/camel-rest-openapi/src/main/java/org/apache/camel/component/rest/openapi/RestOpenapiProcessorStrategy.java
index 325e2468cae..5dab95b0a6f 100644
---
a/components/camel-rest-openapi/src/main/java/org/apache/camel/component/rest/openapi/RestOpenapiProcessorStrategy.java
+++
b/components/camel-rest-openapi/src/main/java/org/apache/camel/component/rest/openapi/RestOpenapiProcessorStrategy.java
@@ -74,4 +74,16 @@ public interface RestOpenapiProcessorStrategy {
*/
boolean process(Operation operation, String path, Exchange exchange,
AsyncCallback callback);
+ /**
+ * Strategy for processing the OpenAPI specification (to return the
contract)
+ *
+ * @param exchange the exchange
+ * @param callback the AsyncCallback will be invoked when the processing
of the exchange is completed. If the
+ * exchange is completed synchronously, then the callback
is also invoked synchronously. The
+ * callback should therefore be careful of starting
recursive loop.
+ * @return (doneSync) true to continue execute synchronously,
false to continue being executed
+ * asynchronously
+ */
+ boolean processApiSpecification(String specificationUri, Exchange
exchange, AsyncCallback callback);
+
}
diff --git
a/core/camel-core-model/src/generated/resources/META-INF/org/apache/camel/model/rest/restConfiguration.json
b/core/camel-core-model/src/generated/resources/META-INF/org/apache/camel/model/rest/restConfiguration.json
index 8f6eabdc526..d72d7945fc5 100644
---
a/core/camel-core-model/src/generated/resources/META-INF/org/apache/camel/model/rest/restConfiguration.json
+++
b/core/camel-core-model/src/generated/resources/META-INF/org/apache/camel/model/rest/restConfiguration.json
@@ -22,7 +22,7 @@
"useXForwardHeaders": { "index": 7, "kind": "attribute", "displayName":
"Use XForward Headers", "label": "consumer,advanced", "required": false,
"type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": false, "description":
"Whether to use X-Forward headers to set host etc. for OpenApi. This may be
needed in special cases involving reverse-proxy and networking going from HTTP
to HTTPS etc. Then the proxy can send X- [...]
"producerApiDoc": { "index": 8, "kind": "attribute", "displayName":
"Producer Api Doc", "label": "producer,advanced", "required": false, "type":
"string", "javaType": "java.lang.String", "deprecated": false, "autowired":
false, "secret": false, "description": "Sets the location of the api document
the REST producer will use to validate the REST uri and query parameters are
valid accordingly to the api document. The location of the api document is
loaded from classpath by default, but [...]
"contextPath": { "index": 9, "kind": "attribute", "displayName": "Context
Path", "label": "consumer", "required": false, "type": "string", "javaType":
"java.lang.String", "deprecated": false, "autowired": false, "secret": false,
"description": "Sets a leading context-path the REST services will be using.
This can be used when using components such as camel-servlet where the deployed
web application is deployed using a context-path. Or for components such as
camel-jetty or camel-netty [...]
- "apiContextPath": { "index": 10, "kind": "attribute", "displayName": "Api
Context Path", "label": "consumer", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "Sets a leading API context-path the REST API
services will be using. This can be used when using components such as
camel-servlet where the deployed web application is deployed using a
context-path." },
+ "apiContextPath": { "index": 10, "kind": "attribute", "displayName": "Api
Context Path", "label": "consumer", "required": false, "type": "string",
"javaType": "java.lang.String", "deprecated": false, "autowired": false,
"secret": false, "description": "Sets a leading context-path the REST API will
be using. This can be used when using components such as camel-servlet where
the deployed web application is deployed using a context-path." },
"apiContextRouteId": { "index": 11, "kind": "attribute", "displayName":
"Api Context Route Id", "label": "consumer,advanced", "required": false,
"type": "string", "javaType": "java.lang.String", "deprecated": false,
"autowired": false, "secret": false, "description": "Sets the route id to use
for the route that services the REST API. The route will by default use an auto
assigned route id." },
"apiVendorExtension": { "index": 12, "kind": "attribute", "displayName":
"Api Vendor Extension", "label": "consumer,advanced", "required": false,
"type": "boolean", "javaType": "java.lang.Boolean", "deprecated": false,
"autowired": false, "secret": false, "defaultValue": false, "description":
"Whether vendor extension is enabled in the Rest APIs. If enabled then Camel
will include additional information as vendor extension (eg keys starting with
x-) such as route ids, class names etc [...]
"hostNameResolver": { "index": 13, "kind": "attribute", "displayName":
"Host Name Resolver", "label": "consumer,advanced", "required": false, "type":
"enum", "javaType": "org.apache.camel.model.rest.RestHostNameResolver", "enum":
[ "allLocalIp", "localHostName", "localIp" ], "deprecated": false, "autowired":
false, "secret": false, "defaultValue": "allLocalIp", "description": "If no
hostname has been explicit configured, then this resolver is used to compute
the hostname the REST ser [...]
diff --git
a/core/camel-core-model/src/main/java/org/apache/camel/model/rest/OpenApiDefinition.java
b/core/camel-core-model/src/main/java/org/apache/camel/model/rest/OpenApiDefinition.java
index 1eefdff7728..91183e54fee 100644
---
a/core/camel-core-model/src/main/java/org/apache/camel/model/rest/OpenApiDefinition.java
+++
b/core/camel-core-model/src/main/java/org/apache/camel/model/rest/OpenApiDefinition.java
@@ -38,6 +38,8 @@ public class OpenApiDefinition extends
OptionalIdentifiedDefinition<OpenApiDefin
@XmlAttribute(required = true)
private String specification;
+ @Metadata
+ private String apiContextPath;
@XmlAttribute
private String routeId;
@XmlAttribute
@@ -72,6 +74,14 @@ public class OpenApiDefinition extends
OptionalIdentifiedDefinition<OpenApiDefin
this.specification = specification;
}
+ public String getApiContextPath() {
+ return apiContextPath;
+ }
+
+ public void setApiContextPath(String apiContextPath) {
+ this.apiContextPath = apiContextPath;
+ }
+
public String getDisabled() {
return disabled;
}
@@ -129,6 +139,15 @@ public class OpenApiDefinition extends
OptionalIdentifiedDefinition<OpenApiDefin
return this;
}
+ /**
+ * Whether to enable api-doc that exposes the OpenAPI specification file
as a REST endpoint.
+ * This allows clients to obtain the specification from the running Camel
application.
+ */
+ public OpenApiDefinition apiContextPath(String apiDoc) {
+ this.apiContextPath = apiDoc;
+ return this;
+ }
+
/**
* Whether to disable the OpenAPI entirely. Once the OpenAPI has been
disabled then it cannot be
* enabled later at runtime.
diff --git
a/core/camel-core-model/src/main/java/org/apache/camel/model/rest/RestConfigurationDefinition.java
b/core/camel-core-model/src/main/java/org/apache/camel/model/rest/RestConfigurationDefinition.java
index 245b339de23..d770f6cae1a 100644
---
a/core/camel-core-model/src/main/java/org/apache/camel/model/rest/RestConfigurationDefinition.java
+++
b/core/camel-core-model/src/main/java/org/apache/camel/model/rest/RestConfigurationDefinition.java
@@ -249,7 +249,7 @@ public class RestConfigurationDefinition {
}
/**
- * Sets a leading API context-path the REST API services will be using.
+ * Sets a leading context-path the REST API will be using.
* <p/>
* This can be used when using components such as <tt>camel-servlet</tt>
where the deployed web application is
* deployed using a context-path.
@@ -582,7 +582,7 @@ public class RestConfigurationDefinition {
}
/**
- * Sets a leading context-path the REST services will be using.
+ * Sets a leading context-path the REST API will be using.
* <p/>
* This can be used when using components such as <tt>camel-servlet</tt>
where the deployed web application is
* deployed using a context-path. Or for components such as
<tt>camel-jetty</tt> or <tt>camel-netty-http</tt> that
diff --git
a/core/camel-core-model/src/main/java/org/apache/camel/model/rest/RestDefinition.java
b/core/camel-core-model/src/main/java/org/apache/camel/model/rest/RestDefinition.java
index 6f1406b8caf..f5d30621789 100644
---
a/core/camel-core-model/src/main/java/org/apache/camel/model/rest/RestDefinition.java
+++
b/core/camel-core-model/src/main/java/org/apache/camel/model/rest/RestDefinition.java
@@ -868,7 +868,7 @@ public class RestDefinition extends
OptionalIdentifiedDefinition<RestDefinition>
addRouteDefinition(camelContext, filter, answer,
config.getComponent(), config.getProducerComponent());
}
if (openApi != null) {
- addRouteDefinition(camelContext, openApi, answer,
config.getComponent(), config.getProducerComponent());
+ addRouteDefinition(camelContext, openApi, answer,
config.getComponent(), config.getProducerComponent(),
config.getApiContextPath());
}
return answer;
@@ -969,7 +969,7 @@ public class RestDefinition extends
OptionalIdentifiedDefinition<RestDefinition>
@SuppressWarnings("rawtypes")
private void addRouteDefinition(
CamelContext camelContext, OpenApiDefinition openApi,
List<RouteDefinition> answer,
- String component, String producerComponent) {
+ String component, String producerComponent, String apiContextPath)
{
RouteDefinition route = new RouteDefinition();
if (openApi.getRouteId() != null) {
@@ -1013,7 +1013,7 @@ public class RestDefinition extends
OptionalIdentifiedDefinition<RestDefinition>
if (producerComponent != null && !producerComponent.isEmpty()) {
options.put("producerComponentName", producerComponent);
}
- Boolean validate = parseBoolean(camelContext,
getClientRequestValidation());
+ Boolean validate = parseBoolean(camelContext,
getClientRequestValidation()); // TODO: move this to open-api so its all the
same place
if (validate != null && validate) {
options.put("requestValidationEnabled", "true");
}
@@ -1023,6 +1023,9 @@ public class RestDefinition extends
OptionalIdentifiedDefinition<RestDefinition>
if (openApi.getMockIncludePattern() != null) {
options.put("mockIncludePattern", openApi.getMockIncludePattern());
}
+ if (openApi.getApiContextPath() != null) {
+ options.put("apiContextPath", openApi.getApiContextPath());
+ }
// include optional description
String description = openApi.getDescription();
diff --git
a/core/camel-xml-io/src/generated/java/org/apache/camel/xml/in/ModelParser.java
b/core/camel-xml-io/src/generated/java/org/apache/camel/xml/in/ModelParser.java
index 3d97bfcbcbb..aaefc3d2747 100644
---
a/core/camel-xml-io/src/generated/java/org/apache/camel/xml/in/ModelParser.java
+++
b/core/camel-xml-io/src/generated/java/org/apache/camel/xml/in/ModelParser.java
@@ -3310,7 +3310,13 @@ public class ModelParser extends BaseParser {
default: return
optionalIdentifiedDefinitionAttributeHandler().accept(def, key, val);
}
return true;
- }, optionalIdentifiedDefinitionElementHandler(), noValueHandler());
+ }, (def, key) -> {
+ if ("apiContextPath".equals(key)) {
+ def.setApiContextPath(doParseText());
+ return true;
+ }
+ return optionalIdentifiedDefinitionElementHandler().accept(def,
key);
+ }, noValueHandler());
}
protected OpenIdConnectDefinition doParseOpenIdConnectDefinition() throws
IOException, XmlPullParserException {
return doParse(new OpenIdConnectDefinition(), (def, key, val) -> {
diff --git
a/core/camel-xml-io/src/generated/java/org/apache/camel/xml/out/ModelWriter.java
b/core/camel-xml-io/src/generated/java/org/apache/camel/xml/out/ModelWriter.java
index c889b477c4f..b2d94894bf5 100644
---
a/core/camel-xml-io/src/generated/java/org/apache/camel/xml/out/ModelWriter.java
+++
b/core/camel-xml-io/src/generated/java/org/apache/camel/xml/out/ModelWriter.java
@@ -4424,6 +4424,7 @@ public class ModelWriter extends BaseWriter {
doWriteAttribute("routeId", def.getRouteId());
doWriteAttribute("specification", def.getSpecification());
doWriteAttribute("disabled", def.getDisabled());
+ doWriteElement("apiContextPath", def.getApiContextPath(),
this::doWriteString);
endElement(name);
}
protected void doWriteOpenIdConnectDefinition(
diff --git
a/core/camel-yaml-io/src/generated/java/org/apache/camel/yaml/out/ModelWriter.java
b/core/camel-yaml-io/src/generated/java/org/apache/camel/yaml/out/ModelWriter.java
index 4630515246d..eecb2246f2d 100644
---
a/core/camel-yaml-io/src/generated/java/org/apache/camel/yaml/out/ModelWriter.java
+++
b/core/camel-yaml-io/src/generated/java/org/apache/camel/yaml/out/ModelWriter.java
@@ -4424,6 +4424,7 @@ public class ModelWriter extends BaseWriter {
doWriteAttribute("routeId", def.getRouteId());
doWriteAttribute("specification", def.getSpecification());
doWriteAttribute("disabled", def.getDisabled());
+ doWriteElement("apiContextPath", def.getApiContextPath(),
this::doWriteString);
endElement(name);
}
protected void doWriteOpenIdConnectDefinition(
diff --git
a/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/RestOpenApiEndpointBuilderFactory.java
b/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/RestOpenApiEndpointBuilderFactory.java
index e53f317f27b..64f42d8e8d1 100644
---
a/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/RestOpenApiEndpointBuilderFactory.java
+++
b/dsl/camel-endpointdsl/src/generated/java/org/apache/camel/builder/endpoint/dsl/RestOpenApiEndpointBuilderFactory.java
@@ -79,6 +79,21 @@ public interface RestOpenApiEndpointBuilderFactory {
doSetProperty("requestValidationEnabled",
requestValidationEnabled);
return this;
}
+ /**
+ * Sets the context-path to use for servicing the OpenAPI
specification.
+ *
+ * The option is a: <code>java.lang.String</code> type.
+ *
+ * Group: consumer
+ *
+ * @param apiContextPath the value to set
+ * @return the dsl builder
+ */
+ default RestOpenApiEndpointConsumerBuilder apiContextPath(
+ String apiContextPath) {
+ doSetProperty("apiContextPath", apiContextPath);
+ return this;
+ }
/**
* Whether the consumer should fail,ignore or return a mock response
for
* OpenAPI operations that are not mapped to a corresponding route.
diff --git
a/dsl/camel-kotlin-api/src/generated/kotlin/org/apache/camel/kotlin/components/RestOpenapiUriDsl.kt
b/dsl/camel-kotlin-api/src/generated/kotlin/org/apache/camel/kotlin/components/RestOpenapiUriDsl.kt
index 038f1cc4836..74e3bbd5f5c 100644
---
a/dsl/camel-kotlin-api/src/generated/kotlin/org/apache/camel/kotlin/components/RestOpenapiUriDsl.kt
+++
b/dsl/camel-kotlin-api/src/generated/kotlin/org/apache/camel/kotlin/components/RestOpenapiUriDsl.kt
@@ -83,6 +83,13 @@ public class RestOpenapiUriDsl(
it.property("requestValidationEnabled",
requestValidationEnabled.toString())
}
+ /**
+ * Sets the context-path to use for servicing the OpenAPI specification
+ */
+ public fun apiContextPath(apiContextPath: String) {
+ it.property("apiContextPath", apiContextPath)
+ }
+
/**
* Whether the consumer should fail,ignore or return a mock response for
OpenAPI operations that
* are not mapped to a corresponding route.
diff --git
a/dsl/camel-yaml-dsl/camel-yaml-dsl-deserializers/src/generated/java/org/apache/camel/dsl/yaml/deserializers/ModelDeserializers.java
b/dsl/camel-yaml-dsl/camel-yaml-dsl-deserializers/src/generated/java/org/apache/camel/dsl/yaml/deserializers/ModelDeserializers.java
index 3aaddb6953b..53d3374a1d2 100644
---
a/dsl/camel-yaml-dsl/camel-yaml-dsl-deserializers/src/generated/java/org/apache/camel/dsl/yaml/deserializers/ModelDeserializers.java
+++
b/dsl/camel-yaml-dsl/camel-yaml-dsl-deserializers/src/generated/java/org/apache/camel/dsl/yaml/deserializers/ModelDeserializers.java
@@ -13875,7 +13875,7 @@ public final class ModelDeserializers extends
YamlDeserializerSupport {
deprecated = false,
properties = {
@YamlProperty(name = "apiComponent", type =
"enum:openapi,swagger", description = "The name of the Camel component to use
as the REST API. If no API Component has been explicit configured, then Camel
will lookup if there is a Camel component responsible for servicing and
generating the REST API documentation, or if a
org.apache.camel.spi.RestApiProcessorFactory is registered in the registry. If
either one is found, then that is being used.", displayName = "Api Component"),
- @YamlProperty(name = "apiContextPath", type = "string",
description = "Sets a leading API context-path the REST API services will be
using. This can be used when using components such as camel-servlet where the
deployed web application is deployed using a context-path.", displayName = "Api
Context Path"),
+ @YamlProperty(name = "apiContextPath", type = "string",
description = "Sets a leading context-path the REST API will be using. This can
be used when using components such as camel-servlet where the deployed web
application is deployed using a context-path.", displayName = "Api Context
Path"),
@YamlProperty(name = "apiContextRouteId", type = "string",
description = "Sets the route id to use for the route that services the REST
API. The route will by default use an auto assigned route id.", displayName =
"Api Context Route Id"),
@YamlProperty(name = "apiHost", type = "string",
description = "To use a specific hostname for the API documentation (such as
swagger or openapi) This can be used to override the generated host with this
configured hostname", displayName = "Api Host"),
@YamlProperty(name = "apiProperty", type =
"array:org.apache.camel.model.rest.RestPropertyDefinition", description =
"Allows to configure as many additional properties for the api documentation.
For example set property api.title to my cool stuff", displayName = "Api
Property"),
diff --git
a/dsl/camel-yaml-dsl/camel-yaml-dsl/src/generated/resources/schema/camelYamlDsl.json
b/dsl/camel-yaml-dsl/camel-yaml-dsl/src/generated/resources/schema/camelYamlDsl.json
index 06660fe71d7..e03199e5b61 100644
---
a/dsl/camel-yaml-dsl/camel-yaml-dsl/src/generated/resources/schema/camelYamlDsl.json
+++
b/dsl/camel-yaml-dsl/camel-yaml-dsl/src/generated/resources/schema/camelYamlDsl.json
@@ -15336,7 +15336,7 @@
"apiContextPath" : {
"type" : "string",
"title" : "Api Context Path",
- "description" : "Sets a leading API context-path the REST API
services will be using. This can be used when using components such as
camel-servlet where the deployed web application is deployed using a
context-path."
+ "description" : "Sets a leading context-path the REST API will be
using. This can be used when using components such as camel-servlet where the
deployed web application is deployed using a context-path."
},
"apiContextRouteId" : {
"type" : "string",
