| QName |
Type |
Use |
Annotation |
| apiComponent |
xs:string |
optional |
The name of the Camel component to use as the REST API (such as swagger) |
|
| apiContextIdPattern |
xs:string |
optional |
Sets an CamelContext id pattern to only allow Rest APIs from rest services
within CamelContext's which name matches the pattern. The pattern name refers to
the CamelContext name to match on the current CamelContext only. For any other
value the pattern uses the rules from link
org.apache.camel.util.EndpointHelpermatchPattern(String String) |
|
| apiContextListing |
xs:boolean |
optional |
Sets whether listing of all available CamelContext's with REST services in the
JVM is enabled. If enabled it allows to discover these contexts if false then
only the current CamelContext is in use. |
|
| apiContextPath |
xs:string |
optional |
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. |
|
| apiContextRouteId |
xs:string |
optional |
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. |
|
| bindingMode |
tns:restBindingMode |
optional |
Sets the binding mode to use. The default value is off |
|
| component |
xs:string |
optional |
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. |
|
| contextPath |
xs:string |
optional |
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-netty4-http that includes a HTTP server. |
|
| enableCORS |
xs:boolean |
optional |
Whether to enable CORS headers in the HTTP response. The default value is false. |
|
| host |
xs:string |
optional |
The hostname to use for exposing the REST service. |
|
| hostNameResolver |
tns:restHostNameResolver |
optional |
If no hostname has been explicit configured then this resolver is used to
compute the hostname the REST service will be using. |
|
| jsonDataFormat |
xs:string |
optional |
Name of specific json data format to use. By default json-jackson will be used.
Important: This option is only for setting a custom name of the data format not
to refer to an existing data format instance. |
|
| port |
xs:string |
optional |
The port number to use for exposing the REST service. Notice if you use servlet
component then the port number configured here does not apply as the port number
in use is the actual port number the servlet component is using. eg if using
Apache Tomcat its the tomcat http port if using Apache Karaf its the HTTP
service in Karaf that uses port 8181 by default etc. Though in those situations
setting the port number here allows tooling and JMX to know the port number so
its recommended to set the port number to the number that the servlet engine
uses. |
|
| scheme |
xs:string |
optional |
The scheme to use for exposing the REST service. Usually http or https is
supported. The default value is http |
|
| skipBindingOnErrorCode |
xs:boolean |
optional |
Whether to skip binding on output if there is a custom HTTP error code header.
This allows to build custom error messages that do not bind to json / xml etc as
success messages otherwise will do. |
|
| xmlDataFormat |
xs:string |
optional |
Name of specific XML data format to use. By default jaxb will be used.
Important: This option is only for setting a custom name of the data format not
to refer to an existing data format instance. |
|