openapi - OpenAPI (openapi)

OpenAPI フィーチャーの構成。

NameTypeDefaultDescription
customizationstringカスタマイズ用の OpenAPI スニペットのロケーションを指定します。
enablePrivateURLbooleanfalseプライベート API ドキュメンテーション・エンドポイントを有効にするかどうか制御するブール値。
publicURLstring/apiパブリック API ドキュメンテーション・エンドポイントのコンテキスト・ルートを指定します。 この URL にはスラッシュ (/) は不要です。
validationbooleanfalseOpenAPI 文書を妥当性検査するかどうかを制御するブール値。
disableFileMonitorbooleanfalseカスタマイズ・ファイルがモニターされるかどうかを制御するブール値。

webModuleDoc

公開する API 文書を提供する各 Web モジュールの構成。

NameTypeDefaultDescription
idstring固有の構成 ID。
contextRootstring文書を提供する対象となる Web モジュールのコンテキスト・ルート。
enabledbooleantrueこの Web モジュールの文書の処理を制御するブール値。
publicbooleantrueパブリック API に Web モジュールが表示されるかどうかを制御するブール値。