2.66. REST OpenApi
RestProducerFactory インターフェイスを実装するコンポーネントに委任する OpenAPI 仕様ドキュメントに基づいて REST プロデューサーを設定します。
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>
<dependency>
<groupId>org.apache.camel.quarkus</groupId>
<artifactId>camel-quarkus-rest-openapi</artifactId>
</dependency>
2.66.3. Usage リンクのコピーリンクがクリップボードにコピーされました!
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>
<dependency>
<groupId>org.apache.camel.quarkus</groupId>
<artifactId>camel-quarkus-http</artifactId>
</dependency>
OpenApi 仕様の読み込みに使用されるメカニズムによっては、追加の依存関係が必要になる場合があります。file
リソースロケーターを使用する場合、org.apache.camel.quarkus:camel-quarkus-file
拡張子をプロジェクトの依存関係として追加する必要があります。ref
または Bean
を使用して仕様をロードする場合、org.apache.camel.quarkus:camel-quarkus-bean
依存関係を追加するだけでなく、Bean 自体に @RegisterForReflection
のアノテーションを付ける必要があります。
ネイティブコードで classpath
リソースロケーターを使用する場合、OpenAPI 仕様へのパスを application.properties
ファイルの quarkus.native.resources.includes
プロパティーで指定する必要があります。以下に例を示します。
quarkus.native.resources.includes=openapi.json
quarkus.native.resources.includes=openapi.json