第 278 章 选项
REST OpenApi 组件支持 10 个选项,如下所列。
Name | 描述 | 默认值 | 类型 |
---|---|---|---|
basePath (producer) | API basePath,如 /v2。默认是 unset,如果设置会覆盖 OpenApi 规格中存在的值。 | 字符串 | |
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)中找到的任何值。可以在端点配置中覆盖。 | 字符串 | |
generate (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 参数):
Name | 描述 | 默认值 | 类型 |
---|---|---|---|
specificationUri | OpenApi 规格文件的路径。方案、主机基础路径从此规格中获取,但可以通过组件或端点级别的属性覆盖。如果没有提供组件,则组件尝试从 classpath 加载 openapi.json 资源。请注意,在这个组件的组件和端点中定义的主机应包含方案、主机名和可选的 URI 语法中的端口(例如 http://api.example.com:8080)。覆盖组件配置。OpenApi 规格可以通过 file: classpath: http: https: 前缀从不同的源加载。对 https 的支持仅限于使用 JDK 安装的 UrlHandler,因此为 https 设置 TLS/SSL 证书(如设置很多 javax.net.ssl JVM 系统属性)。如何参考 UrlHandler 的 JDK 文档。 | openapi.json | URI |
operationId | OpenApi 规格中的操作 所需的 ID。 | 字符串 |