REST API

REST API

Scheme: rest-api
Name Kind Type Required Deprecated Default Value Enum Values Description
path path java.lang.String true false The base path
contextIdPattern path java.lang.String false Optional CamelContext id pattern to only allow Rest APIs from rest services within CamelContext's which name matches the pattern.
componentName parameter java.lang.String false The Camel Rest component to use for the REST transport, such as restlet, spark-rest. If no component has been explicit configured, then Camel will lookup if there is a Camel component that integrates with the Rest DSL, or if a org.apache.camel.spi.RestConsumerFactory is registered in the registry. If either one is found, then that is being used.
apiComponentName parameter java.lang.String false The Camel Rest API component to use for generating the API of the REST services, such as swagger.
exchangePattern parameter org.apache.camel.ExchangePattern false InOnly InOnly
RobustInOnly
InOut
InOptionalOut
OutOnly
RobustOutOnly
OutIn
OutOptionalIn
Sets the default exchange pattern when creating an exchange.
synchronous parameter boolean false false Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). @param synchronous true to enforce synchronous processing