openapi - OpenAPI (openapi)

Konfiguracja składnika OpenAPI.

NameTypeDefaultDescription
customizationstringPołożenie fragmentu kodu OpenAPI dla dostosowania.
enablePrivateURLbooleanfalseWartość logiczna, która decyduje o tym, czy są włączone punkty końcowe dokumentacji prywatnego 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 (/).
validationbooleanfalseWartość boolowska, która decyduje o tym, czy jest sprawdzana poprawność dokumentów OpenAPI.
disableFileMonitorbooleanfalseWartość boolowska, która określa, czy pliki dostosowania są monitorowane.

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.
publicbooleantrueWartość logiczna, która decyduje o tym, czy moduł WWW jest wyświetlany w publicznym interfejsie API.