openapi - OpenAPI (openapi)

Konfiguration für das Feature OpenAPI.

NameTypeDefaultDescription
customizationstringGibt die Position eines OpenAPI-Snippet für die Anpassung an.
enablePrivateURLbooleanfalseEin boolescher Wert, der steuert, ob die privaten API-Dokumentationsendpunkte aktiviert sind.
publicURLstring/apiGibt das Kontextstammverzeichnis für die öffentlichen API-Dokumentationsendpunkte an. Die URL muss keinen Schrägstrich (/) enthalten.
validationbooleanfalseEin boolescher Wert, der steuert, ob OpenAPI-Dokumente validiert werden.
disableFileMonitorbooleanfalseEin boolescher Wert, der steuert, ob die Anpassungsdateien überwacht werden.

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.
publicbooleantrueEin boolescher Wert, der steuert, ob das Webmodul in der öffentlichen API angezeigt wird.