Configuration de la fonctionnalité de détection d'interface de programmation pour la documentation de vos interfaces de programme d'application REST.
Name | Type | Default | Description |
---|---|---|---|
maxSubscriptions | int Min: 0 Max: 100 | 20 | Spécifie le nombre maximal de clients d'API REST simultanés à l'écoute de mises à jour. |
apiName | string | Nom de l'API agrégée. | |
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 (/). |
swaggerDefinition | string | Emplacement de fichier ou adresse URL d'un fragment Swagger JSON ou YAML ou une racine de contexte de l'application à considérer comme la définition Swagger agrégée. |
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. |
docURL | string | URL de la documentation de ce module Web. Cette URL peut être relative à la racine de contexte si elle commence par une barre oblique (/) ou absolue si elle commence par http ou https. | |
public | boolean | true | Valeur booléenne qui contrôle si le module Web est affiché dans l'API publique. |