第 278 章 选项


REST OpenApi 组件支持 10 个选项,如下所列。

名称描述默认值类型

basePath (producer)

API basePath,如 /v2。如果设置覆盖 OpenApi 规格中存在的值,则默认为 unset。

 

字符串

componentName (producer)

将执行请求的 Camel 组件的名称。组件必须存在于 Camel registry 中,它必须实施 RestProducerFactory 服务供应商接口。如果没有设置 CLASSPATH,则会搜索实施 RestProducerFactory SPI 的单个组件。可在端点配置中覆盖。

 

字符串

consumes (producer)

有效负载类型此组件可以消耗什么。可以是一种类型,如 application/json 或多个类型作为 application/json、application/xml;q=0.5 (根据 RFC7231)。这等同于 Accept HTTP 标头的值。如果设置覆盖 OpenApi 规格中找到的任何值。可在端点配置中覆盖

 

字符串

host (producer)

方案主机名和端口,以 https://hostname:port 的形式将 HTTP 请求定向到。可以在端点、组件或 Camel 上下文中的对应 REST 配置下。如果您将这个组件命名为名称(如 petstore),则 REST 配置会首先参考,然后是 rest-openapi,最后是全局配置。如果设置会覆盖 OpenApi 规格 RestConfiguration 中找到的任何值。可在端点配置中覆盖。

 

字符串

produces (producer)

此组件正在生成的有效负载类型。例如,根据 RFC7231 的 application/json 示例。这等同于 Content-Type HTTP 标头的值。如果设置会覆盖 OpenApi 规格中存在的任何值。可在端点配置中覆盖。

 

字符串

specificationUri (producer)

OpenApi 规格文件的路径。方案主机基础路径从此规格中获取,但可使用组件或端点级别的属性覆盖它们。如果没有给定组件,会尝试加载 openapi.json 资源。请注意,在组件和端点上定义的主机应该包含方案、主机名以及 URI 语法的端口(例如 https://api.example.com:8080)。可在端点配置中覆盖。

openapi.json

URI

sslContextParameters (security)

自定义组件使用的 TLS 参数。如果没有设置默认为 Camel 上下文中设置的 TLS 参数

 

SSLContextParameters

useGlobalSslContextParameters (security)

启用使用全局 SSL 上下文参数。

false

布尔值

basicPropertyBinding (advanced)

组件是否应该使用基本属性绑定(Camel 2.x)还是较新的属性与附加功能绑定

false

布尔值

lazyStartProducer (producer)

生成者是否应懒惰启动 (在第一个消息中)。通过懒惰启动,您可以使用此选项来允许 CamelContext 和路由在生成者启动期间启动,并导致路由启动失败。通过懒惰启动,启动失败可以在路由信息时通过 Camel 的路由错误处理程序进行处理。请注意,在处理第一个消息时,创建并启动生成者可能需要稍等时间,并延长处理的总处理时间。

false

布尔值

REST OpenApi 端点使用 URI 语法进行配置:

rest-openapi:specificationUri#operationId

使用以下路径和查询参数:

278.1. 路径参数(2 参数):

名称描述默认值类型

specificationUri

OpenApi 规格文件的路径。方案主机基础路径从此规格中获取,但可使用组件或端点级别的属性覆盖它们。如果没有给定组件,则会尝试从 classpath 加载 openapi.json 资源。请注意,在组件和端点上定义的主机应该包含方案、主机名以及 URI 语法的端口(例如 http://api.example.com:8080)。覆盖组件配置。OpenApi 规格可以通过带有 file: classpath: http: https: 前缀来从不同的源加载。对 https 的支持仅限于使用安装的 UrlHandler,因此对于 https 设置 TLS/SSL 证书(如设置 javax.net.ssl JVM 系统属性的数量)可能会非常小心。如何才能参考 UrlHandler 的 JDK 文档。

openapi.json

URI

operationId

OpenApi 规格中操作 所需的 ID。

 

字符串

Red Hat logoGithubRedditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务,以及可以信赖的内容,帮助红帽用户创新并实现他们的目标。

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情,请参阅红帽博客.

關於紅帽

我们提供强化的解决方案,使企业能够更轻松地跨平台和环境(从核心数据中心到网络边缘)工作。

© 2024 Red Hat, Inc.