REST API

REST API

Description: Rest API component.
Scheme: rest-api
Syntax: rest-api:path/contextId
Maven: org.apache.camel/camel-core/2.16.1
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.
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.
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