REST API

REST API

Scheme: rest-api
Syntax: rest-api:path/contextIdPattern
Description: The rest-api component is used for providing Swagger API of the REST services which has been defined using the rest-dsl in Camel.
Deprecated:false
Maven: org.apache.camel/camel-core/2.17.0.redhat-630356

The rest-api component is used for providing Swagger API of the REST services which has been defined using the rest-dsl in Camel.

Name Kind Group Required Default Type Enum Description
path path consumer true java.lang.String The base path
contextIdPattern path consumer java.lang.String Optional CamelContext id pattern to only allow Rest APIs from rest services within CamelContext's which name matches the pattern.
apiComponentName parameter consumer java.lang.String The Camel Rest API component to use for generating the API of the REST services, such as swagger.
bridgeErrorHandler parameter consumer boolean Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler.

By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN/ERROR level and ignored.

componentName parameter consumer java.lang.String 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.
exceptionHandler parameter consumer (advanced) org.apache.camel.spi.ExceptionHandler To let the consumer use a custom ExceptionHandler. + Notice if the option bridgeErrorHandler is enabled then this options is not in use. + By default the consumer will deal with exceptions, that will be logged at WARN/ERROR level and ignored.
exchangePattern parameter advanced InOnly org.apache.camel.ExchangePattern InOnly
RobustInOnly
InOut
InOptionalOut
OutOnly
RobustOutOnly
OutIn
OutOptionalIn
Sets the default exchange pattern when creating an exchange.
synchronous parameter advanced false boolean 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