openapi - OpenAPI (openapi)

Configuration pour la fonction OpenAPI.

NameTypeDefaultDescription
customizationstringSpécifie l'emplacement d'un fragment OpenAPI pour personnalisation.
enablePrivateURLbooleanfalseValeur booléenne qui détermine si les noeuds finaux de documentation d'API privée API doivent être activés.
publicURLstring/apiSpécifie la racine de contexte des noeuds finaux de la documentation d'API publique. L'URL n'a pas besoin d'une barre oblique (/).
validationbooleanfalseParamètre booléen qui détermine si les documents OpenAPI doivent être validés.
disableFileMonitorbooleanfalseParamètre booléen qui détermine si les fichiers de personnalisation doivent être surveillés.

webModuleDoc

Configuration de chaque module Web qui fournit la documentation d'API à exposer.

NameTypeDefaultDescription
idstringID de configuration unique.
contextRootstringRacine de contexte du module Web pour lequel vous fournissez la documentation.
enabledbooleantrueParamètre booléen qui contrôle le traitement de la documentation pour ce module Web.
publicbooleantrueValeur booléenne qui contrôle si le module Web est affiché dans l'API publique.