Konfiguration für das Feature OpenAPI.
Name | Type | Default | Description |
---|---|---|---|
customization | string | Gibt die Position eines OpenAPI-Snippet für die Anpassung an. | |
enablePrivateURL | boolean | false | Ein boolescher Wert, der steuert, ob die privaten API-Dokumentationsendpunkte aktiviert sind. |
publicURL | string | /api | Gibt das Kontextstammverzeichnis für die öffentlichen API-Dokumentationsendpunkte an. Die URL muss keinen Schrägstrich (/) enthalten. |
validation | boolean | false | Ein boolescher Wert, der steuert, ob OpenAPI-Dokumente validiert werden. |
disableFileMonitor | boolean | false | Ein boolescher Wert, der steuert, ob die Anpassungsdateien überwacht werden. |
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. |
public | boolean | true | Ein boolescher Wert, der steuert, ob das Webmodul in der öffentlichen API angezeigt wird. |