276.2. URI 选项
REST 组件支持 4 个选项,如下所列。
名称 | 描述 | 默认值 | 类型 |
---|---|---|---|
componentName (common) | 用于 REST 传输的 Camel Rest 组件,如 restlet、spark-rest。如果没有明确配置组件,则 Camel 会查找是否有与 Rest DSL 集成的 Camel 组件,或者如果 org.apache.camel.spi.RestConsumerFactory (consumer)或 org.apache.camel.spi.RestProducerFactory (producer)被注册。如果找到其中任何一个,则使用它。 | 字符串 | |
apiDoc (producer) | 要使用的 OpenAPI api doc 资源。默认情况下,资源从 classpath 加载,且必须采用 JSon 格式。 | 字符串 | |
host (producer) | 要使用的 HTTP 服务的主机和端口( OpenAPI 模式中的覆盖主机) | 字符串 | |
resolveProperty Placeholders (advanced) | 启动时组件是否应解析自身上的属性占位符。只有属于 String 类型的属性才能使用属性占位符。 | true | 布尔值 |
REST 端点使用 URI 语法进行配置:
rest:method:path:uriTemplate
使用以下路径和查询参数:
276.2.1. 路径参数(3 参数):
名称 | 描述 | 默认值 | 类型 |
---|---|---|---|
方法 | 需要使用所需的 HTTP 方法。 | 字符串 | |
path | 必需 的基本路径 | 字符串 | |
uriTemplate | uri 模板 | 字符串 |
276.2.2. 查询参数(15 参数):
名称 | 描述 | 默认值 | 类型 |
---|---|---|---|
componentName (common) | 用于 REST 传输的 Camel Rest 组件,如 restlet、spark-rest。如果没有明确配置组件,则 Camel 会查找是否有与 Rest DSL 集成的 Camel 组件,或者如果 registry 中注册了 org.apache.camel.spi.RestConsumerFactory。如果找到其中任何一个,则使用它。 | 字符串 | |
consume (common) | 这个 REST 服务接受的介质类型,如 'text/xml' 或 'application/json'。默认情况下,我们接受所有类型。 | 字符串 | |
inType (common) | 将传入的 POJO 绑定类型声明为 FQN 类名称 | 字符串 | |
outType (common) | 将传出 POJO 绑定类型声明为 FQN 类名称 | 字符串 | |
produces (common) | 介质类型,如:"text/xml' 或 'application/json',这个 REST 服务返回。 | 字符串 | |
routeId (common) | 此 REST 服务创建的路由名称 | 字符串 | |
bridgeErrorHandler (consumer) | 允许将消费者桥接到 Camel 路由错误处理程序,这意味着当消费者试图选择传入消息或类似信息时发生异常,现在将作为消息处理并由路由 Error Handler 处理。默认情况下,使用者将使用 org.apache.camel.spi.ExceptionHandler 处理异常,该处理程序将记录在 WARN/ERROR 级别并忽略。 | false | 布尔值 |
description (consumer) | 记录此 REST 服务的人工描述 | 字符串 | |
exceptionHandler (consumer) | 要让使用者使用自定义例外处理程序:请注意,如果启用了 bridgeErrorHandler 选项,则此选项不使用。默认情况下,消费者将处理例外,该级别将记录在 WARN/ERROR 级别并忽略。 | ExceptionHandler | |
exchangePattern (consumer) | 创建交换时设置默认交换模式。 | ExchangePattern | |
apiDoc (producer) | 要使用的 OpenAPI api doc 资源。默认情况下,资源从 classpath 加载,且必须采用 JSon 格式。 | 字符串 | |
bindingMode (producer) | 配置制作者的绑定模式。如果设置为除 'off' 以外的任何内容,则生成者将尝试将传入消息的正文从 inType 转换为 json 或 xml,并从 json 或 xml 转换为 outType。 | RestBindingMode | |
host (producer) | 要使用的 HTTP 服务的主机和端口( OpenAPI 模式中的覆盖主机) | 字符串 | |
queryParameters (producer) | 要调用的 HTTP 服务的查询参数 | 字符串 | |
同步 (advanced) | 设置是否应严格使用同步处理,或者 Camel 允许使用异步处理(如果受支持)。 | false | 布尔值 |