280.2. オプション


REST Swagger コンポーネントは、以下に示す 9 個のオプションをサポートしています。

名前説明デフォルトタイプ

basePath (producer)

/v2 などの API ベースパス。設定が Swagger 仕様に存在する値をオーバーライドする場合、デフォルトは未設定です。

 

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 ヘッダーの値に相当します。設定すると、Swagger 仕様で見つかった値がオーバーライドされます。エンドポイント設定で上書きできます

 

String

host (producer)

https://hostname:port の形式で HTTP リクエストを送信するスキームのホスト名とポート。エンドポイント、コンポーネント、または Camel コンテキストの対応する REST 設定で設定できます。このコンポーネントに名前 (petstore など) を付けると、最初に REST 設定が参照され、次に rest-swagger が参照され、最後にグローバル設定が参照されます。設定すると、Swagger 仕様で見つかったあらゆる値を上書きする、RestConfiguration。エンドポイント設定で上書きできます。

 

String

produces (producer)

このコンポーネントが生成するペイロードタイプ。たとえば、RFC7231 に従った application/json です。これは、Content-Type HTTP ヘッダーの値に相当します。設定すると、Swagger 仕様に存在するすべての値がオーバーライドされます。エンドポイント設定で上書きできます。

 

String

specificationUri (producer)

Swagger 仕様ファイルへのパス。スキーム、ホストベースパスはこの仕様から取得されますが、これらはコンポーネントまたはエンドポイントレベルのプロパティーでオーバーライドできます。指定されていない場合、コンポーネントは swagger.json リソースを読み込もうとします。このコンポーネントのコンポーネントとエンドポイントで定義されたホストには、スキーマ、ホスト名、およびオプションで URI 構文のポートが含まれている必要があることに注意してください (つまり、https://api.example.com:8080)。エンドポイント設定で上書きできます。

swagger.json

URI

sslContextParameters (security)

コンポーネントが使用する TLS パラメーターをカスタマイズします。設定されていない場合は、Camel コンテキストで設定された TLS パラメーターがデフォルトになります

 

SSLContextParameters

useGlobalSslContext Parameters (security)

グローバル SSL コンテキストパラメーターの使用を有効にします。

false

boolean

resolveProperty Placeholders (advanced)

起動時にコンポーネントがプロパティープレースホルダーを解決するかどうか。String タイプのプロパティーのみがプロパティープレースホルダーを使用できます。

true

boolean

REST Swagger エンドポイントは、URI 構文を使用して設定されます。

rest-swagger:specificationUri#operationId

パスおよびクエリーパラメーターを使用します。

280.2.1. パスパラメーター (2 個のパラメーター):

名前説明デフォルトタイプ

specificationUri

Swagger 仕様ファイルへのパス。スキーム、ホストベースパスはこの仕様から取得されますが、これらはコンポーネントまたはエンドポイントレベルのプロパティーでオーバーライドできます。指定されていない場合、コンポーネントは swagger.json リソースを読み込もうとします。このコンポーネントのコンポーネントとエンドポイントで定義されたホストには、スキーマ、ホスト名、およびオプションで URI 構文のポートが含まれている必要があることに注意してください (つまり、https://api.example.com:8080)。コンポーネント設定をオーバーライドします。

swagger.json

URI

operationId

必須 Swagger 仕様からのオペレーションの ID。

 

String

280.2.2. クエリーパラメーター (6 個のパラメーター):

名前説明デフォルトタイプ

basePath (producer)

/v2 などの API ベースパス。設定が Swagger 仕様およびコンポーネント設定に存在する値をオーバーライドする場合、デフォルトは未設定です。

 

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 ヘッダーの値に相当します。設定すると、Swagger 仕様およびコンポーネント構成で見つかったすべての値をオーバーライドします。

 

String

host (producer)

https://hostname:port の形式で HTTP リクエストを送信するスキームのホスト名とポート。エンドポイント、コンポーネント、または Camel コンテキストの対応する REST 設定で設定できます。このコンポーネントに名前 (petstore など) を付けると、最初に REST 設定が参照され、次に rest-swagger が参照され、最後にグローバル設定が参照されます。設定すると、Swagger 仕様で見つかったあらゆる値を上書きする、RestConfiguration。他のすべての設定をオーバーライドします。

 

String

produces (producer)

このコンポーネントが生成するペイロードタイプ。たとえば、RFC7231 に従った application/json です。これは、Content-Type HTTP ヘッダーの値に相当します。設定すると、Swagger 仕様に存在するすべての値がオーバーライドされます。他のすべての設定をオーバーライドします。

 

String

synchronous (advanced)

同期処理を厳密に使用するか、Camel が非同期処理を使用できるかどうかを設定します (サポートされている場合)。

false

boolean

Red Hat logoGithubRedditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

Red Hat ドキュメントについて

Red Hat をお使いのお客様が、信頼できるコンテンツが含まれている製品やサービスを活用することで、イノベーションを行い、目標を達成できるようにします。

多様性を受け入れるオープンソースの強化

Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。このような変更は、段階的に実施される予定です。詳細情報: Red Hat ブログ.

会社概要

Red Hat は、企業がコアとなるデータセンターからネットワークエッジに至るまで、各種プラットフォームや環境全体で作業を簡素化できるように、強化されたソリューションを提供しています。

© 2024 Red Hat, Inc.