338.2. オプション

cors

Boolean

CORS を有効にするかどうか。これにより、REST サービスへの実際のアクセスではなく、API ブラウザーの CORS のみが有効になることに注意してください。デフォルトは false です。このオプションを使用する代わりに、CorsFilte を使用することを推奨します。詳細は以下を参照してください。

swagger.version

String

Swagger spec バージョン。デフォルトは 2.0 です。

host

String

ホスト名を設定します。設定されていない場合、camel-swagger-java は名前を localhost ベースとして計算します。

schemas

String

使用するプロトコルスキーム。複数の値は、"http,https" のようにコンマで区切ることができます。デフォルト値は「http」です。このオプションは、スキームという名前にする必要があったため、Camel 2.17 以降では 非推奨です。

schemes

String

Camel 2.17: 使用するプロトコルスキーム。複数の値は、"http,https" のようにコンマで区切ることができます。デフォルト値は「http」です。

base.path

String

必須: REST サービスを利用できるベースパスを設定します。パスは相対パス (例: http/https で始まらない) であり、camel-swagger-java は実行時に絶対ベースパスを計算します (protocol://host:port/context-path/base.path)。

api.path

String

API が利用可能なパスを設定します (例:/api-docs)。パスは相対パス (例: http/https で始まらない) であり、camel-swagger-java は実行時に絶対ベースパスを計算します。このパスは protocol://host:port/context-path/api.path で、相対パスを使用するほうがはるかに簡単です。例については、上記を参照してください。

api.version

String

API のバージョン。デフォルトは 0.0.0 です。

api.title

String

アプリケーションの名前。

api.description

String

アプリケーションの簡単な説明。

api.termsOfService

String

API の利用規約への URL。

api.contact.name

String

連絡先に使用する個人または組織の名前

api.contact.email

String

API 関連の連絡に使用するメール。

api.contact.url

String

API 関連の問い合わせ先の Web サイトへの URL。

api.license.name

String

API に適用されるライセンス名。

api.license.url

String

API に使用されるライセンスへの URL。

apiContextIdListing

boolean

REST サービスを持つ JVM ですべての CamelContext 名のリストを許可するかどうか。有効にすると、api-doc のルートパスにすべてのコンテキストが一覧表示されます。無効にすると、コンテキスト ID はリストされず、api-doc のルートパスに現在の CamelContext がリストされます。デフォルトは false です。

apiContextIdPattern

String

コンテキストリストに表示される CamelContext 名をフィルタリングできるパターン。パターンは正規表現と * をワイルドカードとして使用しています。Intercept で使用されるのと同じパターンマッチングです。