第276章 Spring Boot 自動設定
Spring Boot を使用する場合は、自動設定をサポートするために、次の Maven 依存関係を必ず使用してください。
<dependency> <groupId>org.apache.camel.springboot</groupId> <artifactId>camel-rest-openapi-starter</artifactId> <version>x.x.x</version> <!-- use the same version as your Camel core version --> </dependency>
コンポーネントは、以下に記載される 12 のオプションをサポートします。
| 名前 | 説明 | デフォルト | タイプ |
|---|---|---|---|
| camel.component.rest-openapi.base-path | /v2 などの API ベースパス。設定が OpenApi 仕様に存在する値をオーバーライドする場合、デフォルトは未設定です。 | String | |
| camel.component.rest-openapi.basic-property-binding | コンポーネントが基本的なプロパティーバインディング (Camel 2.x) を使用するか、追加機能を備えた新しいプロパティーバインディングを使用するか | false | Boolean |
| camel.component.rest-openapi.bridge-error-handler | コンシューマーの Camel ルーティングエラーハンドラーへのブリッジを許可します。よって、コンシューマーが受信メッセージなどの取得を試行している間に発生した例外は、メッセージとして処理され、ルーティングエラーハンドラーによって処理されます。デフォルトでは、コンシューマーは org.apache.camel.spi.ExceptionHandler を使用して例外に対応し、WARN または ERROR レベルでログに記録され、無視されます。 | false | Boolean |
| camel.component.rest-openapi.component-name | リクエストを実行する Camel コンポーネントの名前。コンポーネントは Camel レジストリーに存在する必要があり、RestProducerFactory サービスプロバイダーインターフェイスを実装する必要があります。設定されていない場合、RestProducerFactory SPI を実装する単一のコンポーネントの CLASSPATH が検索されます。エンドポイント設定で上書きできます。 | String | |
| camel.component.rest-openapi.consumes | このコンポーネントが消費できるペイロードの種類。application/json のように 1 つのタイプにすることも、application/json、application/xml のように複数のタイプにすることもできます。RFC7231 によると、q=0.5 です。これは Accept HTTP ヘッダーの値に相当します。設定すると、OpenApi 仕様で見つかった値がオーバーライドされます。エンドポイント設定で上書きできます。 | String | |
| camel.component.rest-openapi.enabled | rest-openapi コンポーネントの自動設定を有効にするかどうか。これはデフォルトで有効になっています。 | Boolean | |
| camel.component.rest-openapi.host | https://hostname:port の形式で、HTTP リクエストを送信するスキームのホスト名とポート。エンドポイント、コンポーネント、または Camel コンテキストの対応する REST 設定で設定できます。このコンポーネントに名前 (例: petstore) を付けると、REST 設定が最初に参照され、次に rest-openapi が参照され、グローバル設定が最後に参照されます。セットが OpenApi 仕様で見つかった値をオーバーライドする場合、RestConfiguration です。エンドポイント設定で上書きできます。 | String | |
| camel.component.rest-openapi.lazy-start-producer | 最初のメッセージでプロデューサーをレイジーに起動すべきかどうか。レイジーに起動することで、起動時にプロデューサーが失敗し、それによりルートが失敗する可能性がある状況で、CamelContext およびルートの起動を許可します。レイジーな起動を延期すると、Camel のルーティングエラーハンドラー経由でメッセージのルーティング中に起動の失敗を処理できます。最初のメッセージが処理されるときに、プロデューサーの作成および起動に若干時間がかかり、合計処理時間が長くなる可能性があることに注意してください。 | false | Boolean |
| camel.component.rest-openapi.produces | このコンポーネントが生成するペイロードタイプ。たとえば、RFC7231 に従った application/json です。これは、Content-Type HTTP ヘッダーの値に相当します。設定すると、OpenApi 仕様に存在するすべての値がオーバーライドされます。エンドポイント設定で上書きできます。 | String | |
| camel.component.rest-openapi.specification-uri | OpenApi 仕様ファイルへのパス。スキーム、ホストベースパスはこの仕様から取得されますが、これらはコンポーネントまたはエンドポイントレベルのプロパティーでオーバーライドできます。指定されていない場合、コンポーネントは openapi.json リソースを読み込もうとします。このコンポーネントのコンポーネントとエンドポイントで定義されたホストには、スキーマ、ホスト名、およびオプションで URI 構文のポートが含まれている必要があることに注意してください (つまり、https://api.example.com:8080)。エンドポイント設定で上書きできます。 | URI | |
| camel.component.rest-openapi.ssl-context-parameters | コンポーネントが使用する TLS パラメーターをカスタマイズします。設定されていない場合、Camel コンテキストで設定された TLS パラメーターがデフォルトになります。オプションは org.apache.camel.support.jsse.SSLContextParameters タイプです。 | String | |
| camel.component.rest-openapi.use-global-ssl-context-parameters | グローバル SSL コンテキストパラメーターの使用を有効にします。 | false | Boolean |
