OpenAPI フィーチャーの構成。
Name | Type | Default | Description |
---|---|---|---|
customization | string | カスタマイズ用の OpenAPI スニペットのロケーションを指定します。 | |
enablePrivateURL | boolean | false | プライベート API ドキュメンテーション・エンドポイントを有効にするかどうか制御するブール値。 |
publicURL | string | /api | パブリック API ドキュメンテーション・エンドポイントのコンテキスト・ルートを指定します。 この URL にはスラッシュ (/) は不要です。 |
validation | boolean | false | OpenAPI 文書を妥当性検査するかどうかを制御するブール値。 |
disableFileMonitor | boolean | false | カスタマイズ・ファイルがモニターされるかどうかを制御するブール値。 |
公開する API 文書を提供する各 Web モジュールの構成。
Name | Type | Default | Description |
---|---|---|---|
id | string | 固有の構成 ID。 | |
contextRoot | string | 文書を提供する対象となる Web モジュールのコンテキスト・ルート。 | |
enabled | boolean | true | この Web モジュールの文書の処理を制御するブール値。 |
public | boolean | true | パブリック API に Web モジュールが表示されるかどうかを制御するブール値。 |