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