Red Hat Training

A Red Hat training course is available for Red Hat Fuse

261.2. オプション

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

Name説明デフォルトType

basePath (producer)

API basePath(例: /v2)デフォルトは未設定です。設定しないと、Swagger 仕様に存在する値が上書きされます。

 

文字列

componentName (producer)

リクエストを実行する Camel コンポーネントの名前。compnent は Camel レジストリーに存在し、RestProducerFactory サービスプロバイダーインターフェースを実装する必要があります。設定されていない場合は、CLASSPATH が RestProducerFactory SPI を実装する単一のコンポーネントを検索します。エンドポイント設定で上書きできます。

 

文字列

消費 (プロデューサー)

このコンポーネントが消費できるペイロードタイプ。application/json や複数のタイプの application/json、application/xml、q=0.5 など、RFC7231 に従って 1 つのタイプを使用できます。これは Accept HTTP ヘッダーの値と同じです。設定すると、Swagger 仕様で見つかった値が上書きされます。エンドポイント設定で上書き可能

 

文字列

ホスト (プロデューサー)

HTTP 要求を https://hostname:port の形式で転送するスキームホスト名およびポート。エンドポイント、コンポーネント、または Camel Context の correspoding REST 設定で設定できます。このコンポーネントに複数の名前を付けた場合(例: petstore)、REST 設定が最初に参照され、次に rest-swagger およびグローバル設定が最後に確認されます。設定すると、Swagger 仕様で見つかった値が上書きされる場合、RestConfiguration になります。エンドポイント設定で上書きできます。

 

文字列

生成 (プロデューサー)

このコンポーネントによって生成されるペイロードタイプ。たとえば、RFC7231 に準拠する application/json などです。これは Content-Type HTTP ヘッダーの値と同じです。設定すると、Swagger 仕様に存在する値が上書きされます。エンドポイント設定で上書きできます。

 

文字列

specificationUri (producer)

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

swagger.json

URI

resolveProperty Placeholders (advanced)

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

true

boolean

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

rest-swagger:specificationUri#operationId

以下の path パラメーターおよびクエリーパラメーターを使用します。

261.2.1. パスパラメーター(2 パラメーター):

Name説明デフォルトType

specificationUri

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

swagger.json

URI

operationId

Swagger 仕様からの操作に 必要な ID。

 

文字列