apiDiscovery - API feltérképezés (apiDiscovery)

Az API feltérképezési szolgáltatás konfigurálása a REST API-k dokumentálásához.

NameTypeDefaultDescription
maxSubscriptionsint
Min: 0

Max: 100
20A frissítéseket figyelő párhuzamos REST API ügyfelek maximális számát határozza meg.
apiNamestringAz összesített API neve.
publicURLstring/apiMegadja a nyilvános API dokumentációs végpontok kontextusgyökerét. Az URL-ben nem kell megadni osztásjelet (/).
swaggerDefinitionstringFájl helye, vagy egy JSON vagy YAML Swagger kódrészlet URL-címe, vagy az alkalmazás kontextusgyökere, amit összesített Swagger meghatározásként kell kezelni.

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.
docURLstringA webmodul dokumentációjának URL-címe. Az URL cím lehet relatív a kontextusgyökérhez képest, ha jobbra döntött ferde vonallal (/) kezdődik, vagy abszolút, ha http vagy https előtaggal kezdődik.
publiclogikaitrueLogikai érték, ami szabályozza, hogy a webmodul megjelenik-e a nyilvános API-ban.