apiDiscovery - Wykrywanie interfejsu API (apiDiscovery)

Konfiguracja składnika wykrywania interfejsu API służąca do dokumentowania funkcji API usług REST.

NameTypeDefaultDescription
maxSubscriptionsint
Min: 0

Max: 100
20Określa maksymalną liczbę współbieżnych klientów REST API nasłuchujących aktualizacji.
apiNamestringNazwa zagregowanego interfejsu API.
publicURLstring/apiWskazuje kontekstowy katalog główny dla punktów końcowych dokumentacji publicznego interfejsu API. Adres URL nie wymaga użycia ukośnika (/).
swaggerDefinitionstringPołożenie pliku, adres URL fragmentu kodu JSON lub YAML Swagger albo kontekstowy katalog główny aplikacji, która ma zostać użyta jako zagregowana definicja Swagger.

webModuleDoc

Konfiguracja każdego moduły WWW udostępniającego dokumentację interfejsu API do zaprezentowania.

NameTypeDefaultDescription
idłańcuchUnikalny identyfikator konfiguracji.
contextRootstringKontekstowy katalog główny modułu WWW, dla którego udostępniana jest dokumentacja.
enabledbooleantrueWartość boolowska sterująca przetwarzaniem dokumentacji dla tego modułu WWW.
docURLstringAdres URL dokumentacji tego modułu WWW. Adres URL może być adresem względnym wobec kontekstowego katalogu głównego rozpoczynającym się ukośnikiem (/) lub pełnym adresem rozpoczynającym się łańcuchem http lub https.
publicbooleantrueWartość logiczna, która decyduje o tym, czy moduł WWW jest wyświetlany w publicznym interfejsie API.