openapi - OpenAPI (openapi)

Az OpenAPI szolgáltatás konfigurációja.

NameTypeDefaultDescription
customizationstringAz OpenAPI kódrészlet helyét adja meg személyre szabáshoz.
enablePrivateURLlogikaifalseLogikai érték, ami szabályozza, hogy a privát API dokumentációs végpontok engedélyezettek-e.
publicURLstring/apiMegadja a nyilvános API dokumentációs végpontok kontextusgyökerét. Az URL-ben nem kell megadni osztásjelet (/).
validationlogikaifalseEgy logikai érték, amely az OpenAPI dokumentumok érvényesítését szabályozza.
disableFileMonitorlogikaifalseEgy logikai érték, amely azt szabályozza, hogy a személyre szabási fájlok megfigyelés alatt állnak-e.

webModuleDoc

Minden olyan webmodul konfigurálása, amely elérhetővé teszi az API dokumentációt.

NameTypeDefaultDescription
idkaraktersorozatEgyedi konfigurációazonosító.
contextRootstringAzon webmodul kontextusgyökere, amelyhez dokumentációt biztosít.
enabledlogikaitrueA webmodul dokumentációjának feldolgozását szabályzó logikai érték.
publiclogikaitrueLogikai érték, ami szabályozza, hogy a webmodul megjelenik-e a nyilvános API-ban.