276.2. URI オプション
REST コンポーネントは、以下に示す 4 個のオプションをサポートしています。
名前 | 説明 | デフォルト | タイプ |
---|---|---|---|
componentName (common) | restlet、spark-rest などの REST トランスポートに使用する Camel Rest コンポーネント。コンポーネントが明示的に設定されていない場合、Rest DSL と統合する Camel コンポーネントがあるか、または org.apache.camel.spi.RestConsumerFactory (コンシューマー) または org.apache.camel.spi.RestProducerFactory (プロデューサー) がレジストリーに登録されていルカを Camel は検索します。いずれかが見つかった場合は、それが使用されています。 | String | |
apiDoc (producer) | 使用する OpenAPI api doc リソース。リソースはデフォルトでクラスパスからロードされ、JSon 形式である必要があります。 | String | |
host (producer) | 使用する HTTP サービスのホストとポート (OpenAPI スキーマでホストをオーバーライドします)。 | String | |
resolveProperty Placeholders (advanced) | 起動時にコンポーネントがプロパティープレースホルダーを解決するかどうか。String タイプのプロパティーのみがプロパティープレースホルダーを使用できます。 | true | boolean |
REST エンドポイントは、URI 構文を使用して設定されます。
rest:method:path:uriTemplate
パスおよびクエリーパラメーターを使用します。
276.2.1. パスパラメーター (3 パラメーター):
名前 | 説明 | デフォルト | タイプ |
---|---|---|---|
メソッド | 使用する 必須 の HTTP メソッド。 | String | |
path | 必須 ベースパス | String | |
uriTemplate | uri テンプレート | String |
276.2.2. クエリーパラメーター (15 個のパラメーター):
名前 | 説明 | デフォルト | タイプ |
---|---|---|---|
componentName (common) | restlet、spark-rest などの REST トランスポートに使用する Camel Rest コンポーネント。コンポーネントが明示的に設定されていない場合、Rest DSL と統合する Camel コンポーネントがある場合、または org.apache.camel.spi.RestConsumerFactory がレジストリーに登録されている場合、Camel はルックアップします。いずれかが見つかった場合は、それが使用されています。 | String | |
consumes (common) | この REST サービスが受け入れる 'text/xml' または 'application/json' などのメディアタイプ。デフォルトでは、すべての種類のタイプを受け入れます。 | String | |
inType (common) | 着信 POJO バインディングタイプを FQN クラス名として宣言します | String | |
outType (common) | 発信 POJO バインディングタイプを FQN クラス名として宣言します | String | |
produces (common) | この REST サービスが返す 'text/xml' または 'application/json' などのメディアタイプ。 | String | |
routeId (common) | この REST サービスが作成するルートの名前 | String | |
bridgeErrorHandler (consumer) | コンシューマーの Camel ルーティングエラーハンドラーへのブリッジを許可します。よって、コンシューマーが受信メッセージなどの取得を試行している間に発生した例外は、メッセージとして処理され、ルーティングエラーハンドラーによって処理されます。デフォルトでは、コンシューマーは org.apache.camel.spi.ExceptionHandler を使用して例外に対応し、WARN/ERROR レベルでログに記録され、無視されます。 | false | boolean |
description (consumer) | この REST サービスを文書化する人間による説明 | String | |
exceptionHandler (consumer) | コンシューマーによるカスタム ExceptionHandler の使用を許可します。bridgeErrorHandler オプションが有効な場合は、このオプションは使用されないことに注意してください。デフォルトでは、コンシューマーは例外に対応し、WARN/ERROR レベルでログに記録され、無視されます。 | ExceptionHandler | |
exchangePattern (consumer) | エクスチェンジの作成時にデフォルトのエクスチェンジパターンを設定します。 | ExchangePattern | |
apiDoc (producer) | 使用する OpenAPI api doc リソース。リソースはデフォルトでクラスパスからロードされ、JSon 形式である必要があります。 | String | |
bindingMode (producer) | producer のバインディングモードを設定します。'off' 以外に設定されている場合、プロデューサは着信メッセージの本文を inType から json または xml に変換し、json または xml からの応答を outType に変換しようとします。 | RestBindingMode | |
host (producer) | 使用する HTTP サービスのホストとポート (OpenAPI スキーマでホストをオーバーライドします)。 | String | |
queryParameters (producer) | 呼び出す HTTP サービスのクエリーパラメーター | String | |
synchronous (advanced) | 同期処理を厳密に使用するか、Camel が非同期処理を使用できるかどうかを設定します (サポートされている場合)。 | false | boolean |