313.2. オプション
swagger モジュールは、以下のオプションを使用して設定できます。サーブレットを使用して設定するには、上記のように init-param を使用します。rest-dsl で直接設定する場合は、enableCORS、 host、contextPath、dsl などの適切なメソッドを 使用します。api.xxx のオプションは、 apiProperty dsl を使用して設定されます。
| オプション | 型 | 説明 |
|---|---|---|
| cors | ブール値 | CORS を有効にするかどうか。これにより、api ブラウザーの CORS のみが有効になり、REST サービスへの実際のアクセスは有効になりません。デフォルトは false です。CorsFilte の使用が推奨されます。詳細は以下を参照してください。 |
| swagger.version | 文字列 | Swagger 仕様のバージョン。デフォルトは 2.0 です。 |
| host | 文字列 | ホスト名を設定します。camel-swagger-java を設定しないと、名前を localhost ベースとして計算されます。 |
| スキーマ | 文字列 | 使用するプロトコルスキーム。複数の値は、"http,https" のようにコンマで区切ることができます。デフォルト値は「http」です。このオプションは、名前が schemes であるため、Camel 2.17 以降では 非推奨 となっています。 |
| schemes | 文字列 | Camel 2.17: 使用するプロトコルスキーム。複数の値は、"http,https" のようにコンマで区切ることができます。デフォルト値は「http」です。 |
| base.path | 文字列 |
必須: REST サービスが利用できるベースパスを設定します。パスは相対（http/https で開始しない）で、camel-swagger-java はランタイム時に絶対パスを算出します。これは |
| api.path | 文字列 |
API が利用できるパスを設定します（例： /api-docs）。パスは相対（http/https で開始しない）で、camel-swagger-java はランタイム時に絶対ベースパスを算出します。これは |
| api.version | 文字列 | API のバージョン。デフォルトは 0.0.0 です。 |
| api.title | 文字列 | アプリケーションのタイトル。 |
| api.description | 文字列 | アプリケーションの簡単な説明。 |
| api.termsOfService | 文字列 | API 利用規約への URL。 |
| api.contact.name | 文字列 | 連絡先する個人または組織の名前 |
| api.contact.email | 文字列 | API 関連の連絡先に使用するメール。 |
| api.contact.url | 文字列 | 詳細については、Web サイトへの URL。 |
| api.license.name | 文字列 | API に使用されるライセンス名。 |
| api.license.url | 文字列 | API に使用されるライセンスの URL。 |
| apiContextIdListing | boolean | REST サービスを持つ JVM 内のすべての CamelContext 名を一覧表示できるようにするかどうか。有効にすると、api-doc のルートパスはすべてのコンテキストを一覧表示します。無効にするとコンテキスト ID が一覧表示されず、api-doc のルートパスは現在の CamelContext を一覧表示します。デフォルトは false です。 |
| apiContextIdPattern | 文字列 | コンテキストリストに表示される CamelContext 名のフィルターを可能にするパターン。このパターンは正規表現と * をワイルドカードとして使用します。Intercept で使用されるのと同じパターン一致 |
