Konfiguracja składnika OpenAPI.
Name | Type | Default | Description |
---|---|---|---|
customization | string | Położenie fragmentu kodu OpenAPI dla dostosowania. | |
enablePrivateURL | boolean | false | Wartość logiczna, która decyduje o tym, czy są włączone punkty końcowe dokumentacji prywatnego interfejsu API. |
publicURL | string | /api | Wskazuje kontekstowy katalog główny dla punktów końcowych dokumentacji publicznego interfejsu API. Adres URL nie wymaga użycia ukośnika (/). |
validation | boolean | false | Wartość boolowska, która decyduje o tym, czy jest sprawdzana poprawność dokumentów OpenAPI. |
disableFileMonitor | boolean | false | Wartość boolowska, która określa, czy pliki dostosowania są monitorowane. |
Konfiguracja każdego moduły WWW udostępniającego dokumentację interfejsu API do zaprezentowania.
Name | Type | Default | Description |
---|---|---|---|
id | łańcuch | Unikalny identyfikator konfiguracji. | |
contextRoot | string | Kontekstowy katalog główny modułu WWW, dla którego udostępniana jest dokumentacja. | |
enabled | boolean | true | Wartość boolowska sterująca przetwarzaniem dokumentacji dla tego modułu WWW. |
public | boolean | true | Wartość logiczna, która decyduje o tym, czy moduł WWW jest wyświetlany w publicznym interfejsie API. |