2.66. REST OpenApi
根据 OpenAPI 规格文档配置 REST producer,委派到实施 RestProducerFactory 接口的组件。
2.66.1. 内部是什么
-
REST OpenApi 组件, URI 语法:
rest-openapi:specificationUri#operationId
有关使用和配置详情,请参阅上述链接。
2.66.2. Maven 协调
在 code.quarkus.redhat.com 上使用此扩展创建一个新项目
或者将协调添加到现有项目中:
<dependency> <groupId>org.apache.camel.quarkus</groupId> <artifactId>camel-quarkus-rest-openapi</artifactId> </dependency>
2.66.3. 使用方法
2.66.3.1. 所需的依赖项
在使用 rest-openapi 扩展时,必须有一个 RestProducerFactory
实现。当前已知的扩展有:
- camel-quarkus-http
- camel-quarkus-netty-http
Maven 用户需要将其中一个依赖项添加到其 pom.xml
中,例如:
<dependency> <groupId>org.apache.camel.quarkus</groupId> <artifactId>camel-quarkus-http</artifactId> </dependency>
根据使用哪个机制来加载 OpenApi 规格,可能需要额外的依赖项。使用 文件
资源 locator 时,必须将 org.apache.camel.quarkus:camel-quarkus-file
扩展添加为项目依赖项。当使用 ref
或 bean
加载规格时,不仅必须添加 org.apache.camel.quarkus:camel-quarkus-bean
依赖项,而是必须使用 @RegisterForReflection
注解 bean 本身。
将 classpath
资源 locator 与原生代码搭配使用时,必须在 application.properties
文件的 quarkus.native.resources.includes
属性中指定 OpenAPI 规格的路径。例如:
quarkus.native.resources.includes=openapi.json