281.2. 选项
REST Swagger 组件支持 9 个选项,如下所列。
Name | 描述 | 默认值 | 类型 |
---|---|---|---|
basePath (producer) | API basePath,如 /v2。默认会被取消设置,如果设置会覆盖 Swagger 规格中存在的值。 | 字符串 | |
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。可以在端点配置中覆盖。 | 字符串 | |
generate (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 参数 (security) | 启用使用全局 SSL 上下文参数。 | false | 布尔值 |
resolveProperty Placeholders (advanced) | 组件是否应在启动时解析属性占位符。只有 String 类型的属性可以使用属性占位符。 | true | 布尔值 |
REST Swagger 端点使用 URI 语法进行配置:
rest-swagger:specificationUri#operationId
使用以下路径和查询参数:
281.2.1. 路径参数(2 参数):
Name | 描述 | 默认值 | 类型 |
---|---|---|---|
specificationUri | Swagger 规格文件的路径。方案、主机基础路径从此规格中获取,但可以使用组件或端点级别的属性覆盖。如果没有给定组件尝试加载 swagger.json 资源。请注意,在这个组件的组件和端点中定义的主机应包含方案、主机名和可选的 URI 语法中的端口(例如 https://api.example.com:8080)。覆盖组件配置。 | swagger.json | URI |
operationId | Swagger 规格中的操作 所需的 ID。 | 字符串 |
281.2.2. 查询参数(6 参数):
Name | 描述 | 默认值 | 类型 |
---|---|---|---|
basePath (producer) | API basePath,如 /v2。默认会被取消设置,如果设置会覆盖 Swagger 规格和组件配置中存在的值。 | 字符串 | |
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。覆盖所有其他配置。 | 字符串 | |
generate (producer) | 此组件生成的有效负载类型。例如,根据 RFC7231 的 application/json。这等同于 Content-Type HTTP 标头的值。如果设置覆盖 Swagger 规格中存在的任何值。覆盖所有其他配置。 | 字符串 | |
同步 (高级) | 设置是否应严格使用同步处理,还是允许 Camel 使用异步处理(如果支持)。 | false | 布尔值 |