Konfiguration für das API-Erkennungsfeature zum Dokumentieren von REST-APIs.
Name | Type | Default | Description |
---|---|---|---|
maxSubscriptions | int Min: 0 Max: 100 | 20 | Gibt die maximale Anzahl an REST-API-Clients an, die gleichzeitig auf Aktualisierungen warten. |
apiName | string | Der Name der aggregierten API. | |
publicURL | string | /api | Gibt das Kontextstammverzeichnis für die öffentlichen API-Dokumentationsendpunkte an. Die URL muss keinen Schrägstrich (/) enthalten. |
swaggerDefinition | string | Eine Dateiposition oder die URL eines JSON- oder YAML-Swagger-Snippets oder das Kontextstammverzeichnis der Anwendung, das als aggregrierte Swagger-Definition verwendet werden soll. |
Konfiguration für jedes Webmodul, das bereitzustellende API-Dokumentation enthält.
Name | Type | Default | Description |
---|---|---|---|
id | string | Eine eindeutige Konfigurations-ID. | |
contextRoot | string | Das Kontextstammverzeichnis des Webmoduls, für das Sie Dokumentation bereitstellen. | |
enabled | boolean | true | Ein Wert des Datentyps Boolean, der die Verarbeitung der Dokumentation für dieses Webmodul steuert. |
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. | |
public | boolean | true | Ein boolescher Wert, der steuert, ob das Webmodul in der öffentlichen API angezeigt wird. |