第277章 オプション
REST OpenApi コンポーネントは、以下に示す 10 個のオプションをサポートしています。
名前 | 説明 | デフォルト | タイプ |
---|---|---|---|
basePath (producer) | /v2 などの API ベースパス。設定が OpenApi 仕様に存在する値をオーバーライドする場合、デフォルトは未設定です。 | String | |
componentName (producer) | リクエストを実行する Camel コンポーネントの名前。コンポーネントは Camel レジストリーに存在する必要があり、RestProducerFactory サービスプロバイダーインターフェイスを実装する必要があります。設定されていない場合、RestProducerFactory SPI を実装する単一のコンポーネントの CLASSPATH が検索されます。エンドポイント設定で上書きできます。 | String | |
consumes (producer) | このコンポーネントが消費できるペイロードの種類。application/json のように 1 つのタイプにすることも、application/json、application/xml のように複数のタイプにすることもできます。RFC7231 によると、q=0.5 です。これは Accept HTTP ヘッダーの値に相当します。設定すると、OpenApi 仕様で見つかった値がオーバーライドされます。エンドポイント設定で上書きできます。 | String | |
host (producer) | https://hostname:port の形式で、HTTP リクエストを送信するスキームのホスト名とポート。エンドポイント、コンポーネント、または Camel コンテキストの対応する REST 設定で設定できます。このコンポーネントに名前 (例: petstore) を付けると、REST 設定が最初に参照され、次に rest-openapi が参照され、グローバル設定が最後に参照されます。セットが OpenApi 仕様で見つかった値をオーバーライドする場合、RestConfiguration です。エンドポイント設定で上書きできます。 | String | |
produces (producer) | このコンポーネントが生成するペイロードタイプ。たとえば、RFC7231 に従った application/json です。これは、Content-Type HTTP ヘッダーの値に相当します。設定すると、OpenApi 仕様に存在するすべての値がオーバーライドされます。エンドポイント設定で上書きできます。 | String | |
specificationUri (producer) | OpenApi 仕様ファイルへのパス。スキーム、ホストベースパスはこの仕様から取得されますが、これらはコンポーネントまたはエンドポイントレベルのプロパティーでオーバーライドできます。指定されていない場合、コンポーネントは openapi.json リソースを読み込もうとします。このコンポーネントのコンポーネントとエンドポイントで定義されたホストには、スキーマ、ホスト名、およびオプションで URI 構文のポートが含まれている必要があることに注意してください (つまり、https://api.example.com:8080)。エンドポイント設定で上書きできます。 | openapi.json | URI |
sslContextParameters (security) | コンポーネントが使用する TLS パラメーターをカスタマイズします。設定されていない場合は、Camel コンテキストで設定された TLS パラメーターがデフォルトになります | SSLContextParameters | |
useGlobalSslContextParameters (security) | グローバル SSL コンテキストパラメーターの使用を有効にします。 | false | boolean |
basicPropertyBinding (advanced) | コンポーネントが基本的なプロパティーバインディング (Camel 2.x) を使用するか、追加機能を備えた新しいプロパティーバインディングを使用するか | false | boolean |
lazyStartProducer (producer) | 最初のメッセージでプロデューサーをレイジーに起動すべきかどうか。レイジーに起動することで、起動時にプロデューサーが失敗し、それによりルートが失敗する可能性がある状況で、CamelContext およびルートの起動を許可します。レイジーな起動を延期すると、Camel のルーティングエラーハンドラー経由でメッセージのルーティング中に起動の失敗を処理できます。最初のメッセージが処理されるときに、プロデューサーの作成および起動に若干時間がかかり、合計処理時間が長くなる可能性があることに注意してください。 | false | boolean |
REST OpenApi エンドポイントは、URI 構文を使用して設定されます。
rest-openapi:specificationUri#operationId
パスおよびクエリーパラメーターを使用します。
277.1. パスパラメーター (2 個のパラメーター):
名前 | 説明 | デフォルト | タイプ |
---|---|---|---|
specificationUri | OpenApi 仕様ファイルへのパス。スキーム、ホストベースパスはこの仕様から取得されますが、これらはコンポーネントまたはエンドポイントレベルのプロパティーでオーバーライドできます。指定されていない場合、コンポーネントはクラスパスから openapi.json リソースを読み込もうとします。このコンポーネントのコンポーネントとエンドポイントで定義されたホストには、スキーマ、ホスト名、およびオプションで URI 構文のポートが含まれている必要があることに注意してください (つまり、http://api.example.com:8080)。コンポーネント設定をオーバーライドします。OpenApi 仕様は、file: classpath: http: https: の接頭辞を付けることで、さまざまなソースから読み込むことができます。https のサポートは、JDK がインストールされた UrlHandler の使用に制限されているため、https の TLS/SSL 証明書をセットアップするのは面倒な場合があります (多数の javax.net.ssl JVM システムプロパティーの設定など)。その方法については、UrlHandler の JDK ドキュメントを参照してください。 | openapi.json | URI |
operationId | 必須 OpenApi 仕様からのオペレーションの ID。 | String |