278.2. 选项


REST Swagger 组件支持下面列出的 7 选项。

名称描述默认类型

basePath (producer)

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

 

字符串

componentName (producer)

将执行请求的 Camel 组件的名称。Camel 注册表中必须包括 compnent,它必须实施 RestProducerFactory 服务提供程序接口。如果没有设置 CLASSPATH,则会搜索实现 RestProducerFactory SPI 的单个组件。可以在端点配置中覆盖。

 

字符串

consumes (producer)

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

 

字符串

host (producer)

方案主机名和端口以 https://hostname:port 的形式将 HTTP 请求定向到。可以在 端点、组件或在 Camel 上下文中配置 REST 配置。如果您为这个组件指定一个名称(例如,Ppetstore),则首先会参考 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

resolveProperty Placeholders (advanced)

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

true

布尔值

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

rest-swagger:specificationUri#operationId

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

278.2.1. 路径名(2 参数):

名称描述默认类型

specificationUri

Swagger 规格文件的路径。这个规格中采用主机基本路径,但可以使用组件或端点级别的属性覆盖它们。如果未指定组件,则组件会尝试加载 swagger.json 资源。请注意,在组件和端点中定义的主机应包含 URI 语法(例如 https://api.example.com:8080)中的方案、主机名和端口的可选端口。覆盖组件配置。

swagger.json

URI

operationId

Swagger 规格中操作所需的 ID。

 

字符串

Red Hat logoGithubRedditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

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

让开源更具包容性

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

關於紅帽

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

© 2024 Red Hat, Inc.