52.4. エンドポイントオプション
REST エンドポイントは、URI 構文を使用して設定されます。
rest:method:path:uriTemplate
rest:method:path:uriTemplate
パスおよびクエリーパラメーターを使用します。
52.4.1. パスパラメーター (3 パラメーター) リンクのコピーリンクがクリップボードにコピーされました!
名前 | 説明 | デフォルト | タイプ |
---|---|---|---|
method (common) | 使用する 必須 の HTTP メソッド。 列挙値:
| String | |
path (common) | 必須 ベースパス。 | String | |
uriTemplate (common) | uri テンプレート。 | String |
52.4.2. クエリーパラメーター (16 パラメーター) リンクのコピーリンクがクリップボードにコピーされました!
名前 | 説明 | デフォルト | タイプ |
---|---|---|---|
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 ルーティングエラーハンドラーへのブリッジを許可します。よって、コンシューマーが受信メッセージなどの取得を試行している間に発生した例外は、メッセージとして処理され、ルーティングエラーハンドラーによって処理されます。デフォルトでは、consumer は org.apache.camel.spi.ExceptionHandler を使用して例外に対応し、WARN または ERROR レベルでログに記録され、無視されます。 | false | boolean |
consumerComponentName (consumer) | (consumer) REST トランスポート (jetty、servlet、undertow など) に使用する Camel Rest コンポーネント。コンポーネントが明示的に設定されていない場合、Rest DSL と統合する Camel コンポーネントがある場合、または org.apache.camel.spi.RestConsumerFactory がレジストリーに登録されている場合、Camel はルックアップします。いずれかが見つかった場合は、それが使用されています。 | String | |
description (consumer) | この REST サービスを文書化する人間による説明。 | String | |
exceptionHandler (consumer (advanced)) | consumer によるカスタム ExceptionHandler の使用を許可します。bridgeErrorHandler オプションが有効な場合は、このオプションは使用されないことに注意してください。デフォルトでは、consumer は例外に対応し、WARN または ERROR レベルでログに記録され、無視されます。 | ExceptionHandler | |
exchangePattern (consumer (advanced)) | 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 | |
lazyStartProducer (producer) | 最初のメッセージでプロデューサーをレイジーに起動すべきかどうか。レイジーに起動することで、起動時に producer が失敗し、それによりルートが失敗する可能性がある状況で、CamelContext およびルートの起動を許可します。レイジーな起動を延期すると、Camel のルーティングエラーハンドラー経由でメッセージのルーティング中に起動の失敗を処理できます。最初のメッセージが処理されるときに、producer の作成および起動に若干時間がかかり、合計処理時間が長くなる可能性があることに注意してください。 | false | boolean |
producerComponentName (producer) | http、undertow などの REST トランスポート (producer) に使用する Camel Rest コンポーネント。コンポーネントが明示的に設定されていないと、Rest DSL と統合する Camel コンポーネントがある場合、または org.apache.camel.spi.RestProducerFactory がレジストリーに登録されている場合は、Camel がルックアップします。いずれかが見つかった場合は、それが使用されています。 | String | |
queryParameters (producer) | 呼び出す HTTP サービスのクエリーパラメーター。クエリーパラメーターには、foo=123&bar=456 のように、アンパサンドで区切られた複数のパラメーターを含めることができます。 | String |