API-Erkennung (apiDiscovery)
Konfiguration für das API-Erkennungsfeature zum Dokumentieren von REST-APIs.
Attributname | Datentyp | Standardwert | Beschreibung |
---|---|---|---|
apiName | string | Der Name der aggregierten API. | |
maxSubscriptions | int
Minimum: 0 Maximum: 100 |
20 | Gibt die maximale Anzahl an REST-API-Clients an, die gleichzeitig auf Aktualisierungen warten. |
publicURL | string | /api | %publicURL.desc |
swaggerDefinition | string | %swaggerDefinition.desc |
- webModuleDoc
Beschreibung: Konfiguration für jedes Webmodul, das bereitzustellende API-Dokumentation enthält.Erforderlich: falseDatentyp: Attributname Datentyp Standardwert Beschreibung contextRoot string Das Kontextstammverzeichnis des Webmoduls, für das Sie Dokumentation bereitstellen. docURL string Die URL der Dokumentation dieses Webmoduls. Die URL kann relativ zum Kontextstammverzeichnis (mit einem Schrägstrich (/) am Anfang) oder absolut (mit http oder https am Anfang) angegeben werden. enabled boolean true Ein Wert des Datentyps Boolean, der die Verarbeitung der Dokumentation für dieses Webmodul steuert. id string Eine eindeutige Konfigurations-ID. public boolean true %public.desc