78.2. オプション
OpenApi モジュールは、以下のオプションで設定することができます。サーブレットを使って設定する場合は、上記のように init-param を使用します。rest-dsl で直接設定する場合は、enableCORS , host、contextPath、dsl などの適切な方法を使用します。api.xxx によるオプションは、apiProperty dsl を用いて設定する。
| オプション | タイプ | 説明 |
|---|---|---|
| cors | ブール値 | CORS を有効にするかどうか。これは、API ブラウザーの CORS を有効にするだけで、REST サービスへの実際のアクセスは有効にしないことに注意してください。デフォルトは false。 |
| openapi.version | 文字列 | OpenApi 仕様のバージョン。デフォルトは 3.0 です。 |
| host | 文字列 | ホスト名を設定する。設定されていない場合、camel-openapi-java は localhost ベースの名前を計算します。 |
| schemes | 文字列 | 使用するプロトコルスキーム。http,https " のようにコンマで区切って複数の値を指定することができる。デフォルト値は「http」です。 |
| base.path | 文字列 |
必須: REST サービスを利用できるベースパスを設定します。パスは相対パスで (例えば http/https で始まらない)、camel-openapi-java は実行時に絶対ベースパスを計算し、それは |
| api.path | 文字列 |
API が利用できるパスを設定する (例:/api-docs)。パスは相対的であり (例えば http/https で始まらない)、camel-openapi-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 | 文字列 | API 関連の問い合わせ先の Web サイトへの URL。 |
| api.license.name | 文字列 | API に使用されるライセンス名です。 |
| api.license.url | 文字列 | API に使用されるライセンスへの URL。 |