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