2.64. REST OpenApi


根据委派给实施 RestProducerFactory 接口的组件,配置 REST 制作者文档。

2.64.1. 内部内容

有关使用和配置详情,请参阅上述链接。

2.64.2. Maven 协调

在 code.quarkus.redhat.com 上创建一个具有此扩展名的新项目

或者在现有项目中添加协调:

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-rest-openapi</artifactId>
</dependency>

2.64.3. 使用方法

2.64.3.1. 所需的依赖项

使用 rest-openapi 扩展时,必须有 RestProducerFactory 实现。当前已知的扩展有:

  • camel-quarkus-http

Maven 用户需要将其中一个依赖项添加到其 pom.xml 中,例如:

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-http</artifactId>
</dependency>

根据用于加载 OpenApi 规格的机制,可能需要其他依赖项。使用 file 资源 locator 时,必须将 org.apache.camel.quarkus:camel-quarkus-file 扩展添加为项目依赖项。当使用 refbean 加载规范时,不仅必须添加 org.apache.camel.quarkus:camel-quarkus-bean 依赖项,但 bean 本身必须标注为 @RegisterForReflection

classpath 资源 locator 与原生代码搭配使用时,OpenAPI 规格的路径必须在 application.properties 文件的 quarkus.native.resources.includes 属性中指定。例如:

quarkus.native.resources.includes=openapi.json
Red Hat logoGithubRedditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

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

让开源更具包容性

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

關於紅帽

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

© 2024 Red Hat, Inc.