apiDiscovery - API-Erkennung (apiDiscovery)

Konfiguration für das API-Erkennungsfeature zum Dokumentieren von REST-APIs.

NameTypeDefaultDescription
maxSubscriptionsint
Min: 0

Max: 100
20Gibt die maximale Anzahl an REST-API-Clients an, die gleichzeitig auf Aktualisierungen warten.
apiNamestringDer Name der aggregierten API.
publicURLstring/apiGibt das Kontextstammverzeichnis für die öffentlichen API-Dokumentationsendpunkte an. Die URL muss keinen Schrägstrich (/) enthalten.
swaggerDefinitionstringEine Dateiposition oder die URL eines JSON- oder YAML-Swagger-Snippets oder das Kontextstammverzeichnis der Anwendung, das als aggregrierte Swagger-Definition verwendet werden soll.

webModuleDoc

Konfiguration für jedes Webmodul, das bereitzustellende API-Dokumentation enthält.

NameTypeDefaultDescription
idstringEine eindeutige Konfigurations-ID.
contextRootstringDas Kontextstammverzeichnis des Webmoduls, für das Sie Dokumentation bereitstellen.
enabledbooleantrueEin Wert des Datentyps Boolean, der die Verarbeitung der Dokumentation für dieses Webmodul steuert.
docURLstringDie 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.
publicbooleantrueEin boolescher Wert, der steuert, ob das Webmodul in der öffentlichen API angezeigt wird.