Configuration pour la fonction OpenAPI.
Name | Type | Default | Description |
---|---|---|---|
customization | string | Spécifie l'emplacement d'un fragment OpenAPI pour personnalisation. | |
enablePrivateURL | boolean | false | Valeur booléenne qui détermine si les noeuds finaux de documentation d'API privée API doivent être activés. |
publicURL | string | /api | Spécifie la racine de contexte des noeuds finaux de la documentation d'API publique. L'URL n'a pas besoin d'une barre oblique (/). |
validation | boolean | false | Paramètre booléen qui détermine si les documents OpenAPI doivent être validés. |
disableFileMonitor | boolean | false | Paramètre booléen qui détermine si les fichiers de personnalisation doivent être surveillés. |
Configuration de chaque module Web qui fournit la documentation d'API à exposer.
Name | Type | Default | Description |
---|---|---|---|
id | string | ID de configuration unique. | |
contextRoot | string | Racine de contexte du module Web pour lequel vous fournissez la documentation. | |
enabled | boolean | true | Paramètre booléen qui contrôle le traitement de la documentation pour ce module Web. |
public | boolean | true | Valeur booléenne qui contrôle si le module Web est affiché dans l'API publique. |