44.4. 端点选项
REST 端点使用 URI 语法进行配置:
rest:method:path:uriTemplate
rest:method:path:uriTemplate
使用以下路径和查询参数:
44.4.1. 路径参数(3 参数) 复制链接链接已复制到粘贴板!
| 名称 | 描述 | 默认 | 类型 |
|---|---|---|---|
| 方法 (通用) | 要使用 所需的 HTTP 方法。 Enum 值:
| 字符串 | |
| 路径 (common) | 所需的 基本路径。 | 字符串 | |
| uritemplate (common) | uri 模板。 | 字符串 |
44.4.2. 查询参数(16 参数) 复制链接链接已复制到粘贴板!
| 名称 | 描述 | 默认 | 类型 |
|---|---|---|---|
| 使用 (common) | 此 REST 服务接受的介质类型,如 'text/xml' 或 'application/json'。默认情况下,我们接受所有类型。 | 字符串 | |
| inType (common) | 将传入的 POJO 绑定类型声明为 FQN 类名称。 | 字符串 | |
| outType (common) | 将传出 POJO 绑定类型声明为 FQN 类名称。 | 字符串 | |
| generate (common) | 此 REST 服务返回的介质类型,如 'text/xml' 或 'application/json'。 | 字符串 | |
| routeId (common) | 此 REST 服务创建的路由的名称。 | 字符串 | |
| bridgeErrorHandler (consumer) | 允许将消费者桥接到 Camel 路由错误处理程序,这意味着当消费者试图选择传入消息或类似信息时发生异常,现在将作为消息处理并由路由 Error Handler 处理。默认情况下,使用者将使用 org.apache.camel.spi.ExceptionHandler 来处理例外情况,该处理程序将被记录在 WARN 或 ERROR 级别,并忽略。 | false | 布尔值 |
| consumerComponentName (consumer) | 用于(消费者)REST 传输的 Camel Rest 组件,如 jetty、servlet、undertow。如果没有明确配置组件,则 Camel 将查找与 Rest DSL 集成的 Camel 组件,或者 registry 中注册了 org.apache.camel.spi.RestConsumerFactory。如果找到其中任何一个,则使用它。 | 字符串 | |
| 描述 (使用者) | 记录此 REST 服务的人为描述。 | 字符串 | |
| exceptionHandler (消费者) | 要让使用者使用自定义例外处理程序:请注意,如果启用了 bridgeErrorHandler 选项,则此选项不在使用。默认情况下,使用者将处理异常,其记录在 WARN 或 ERROR 级别中,并忽略。 | ExceptionHandler | |
| ExchangePattern (消费者) | 在消费者创建交换时设置交换模式。 Enum 值:
| ExchangePattern | |
| apidoc (producer) | 要使用的 openapi api doc 资源。资源默认从 classpath 加载,且必须采用 JSON 格式。 | 字符串 | |
| bindingMode (producer) | 配置制作者的绑定模式。如果设置为 'off' 以外的任何内容,则制作者会尝试将传入消息的正文从 inType 转换为 json 或 xml,以及从 json 或 xml 的响应转换为 outType。 Enum 值:
| RestBindingMode | |
| 主机 (生成器) | 要使用的 HTTP 服务的主机和端口(在 openapi schema 中的override 主机)。 | 字符串 | |
| lazyStartProducer (producer) | 制作者是否应启动 lazy (在第一个消息中)。通过启动 lazy,您可以使用此选项来允许 CamelContext 和路由在制作者启动期间启动,并导致路由启动失败。通过将这个启动延迟到延迟,那么可以通过 Camel 的路由错误处理程序路由消息期间,可以处理启动失败。请注意,在处理第一个消息时,创建并启动制作者可能需要稍等时间,并延长处理的总处理时间。 | false | 布尔值 |
| producerComponentName (producer) | 用于(生成)REST 传输(如 http, undertow)的 Camel Rest 组件。如果没有明确配置组件,则 Camel 将查找与 Rest DSL 集成的 Camel 组件,或者 registry 中注册了 org.apache.camel.spi.RestProducerFactory。如果找到其中任何一个,则使用它。 | 字符串 | |
| queryParameters (producer) | 要调用的 HTTP 服务的查询参数。查询参数可以包含多个参数,如 foo=123&bar=456。 | 字符串 |