281.2. 选项


REST Swagger 组件支持 9 个选项,如下所列。

名称描述默认值类型

basePath (producer)

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

 

字符串

componentName (producer)

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

 

字符串

consumes (producer)

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

 

字符串

host (producer)

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

 

字符串

produces (producer)

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

 

字符串

specificationUri (producer)

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

swagger.json

URI

sslContextParameters (security)

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

 

SSLContextParameters

useGlobalSslContext Parameters (security)

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

false

布尔值

resolveProperty Placeholders (advanced)

启动时组件是否应解析自身上的属性占位符。只有属于 String 类型的属性才能使用属性占位符。

true

布尔值

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

rest-swagger:specificationUri#operationId

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

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

名称描述默认值类型

specificationUri

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

swagger.json

URI

operationId

从 Swagger 规格中操作 所需的 ID。

 

字符串

281.2.2. 查询参数(6 参数):

名称描述默认值类型

basePath (producer)

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

 

字符串

componentName (producer)

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

 

字符串

consumes (producer)

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

 

字符串

host (producer)

方案主机名和端口,以 https://hostname:port 的形式将 HTTP 请求定向到。可以在端点、组件或 Camel 上下文中的 correspoding REST 配置。如果您将这个组件命名为名称(如 petstore),则 REST 配置首先、rest-swagger 下一个和全局配置。如果设置覆盖 Swagger 规格中找到的任何值,则 RestConfiguration。覆盖所有其他配置。

 

字符串

produces (producer)

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

 

字符串

同步 (advanced)

设置是否应严格使用同步处理,或者 Camel 允许使用异步处理(如果受支持)。

false

布尔值

Red Hat logoGithubRedditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

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

让开源更具包容性

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

關於紅帽

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

© 2024 Red Hat, Inc.