Konfiguracja składnika wykrywania interfejsu API służąca do dokumentowania funkcji API usług REST.
Name | Type | Default | Description |
---|---|---|---|
maxSubscriptions | int Min: 0 Max: 100 | 20 | Określa maksymalną liczbę współbieżnych klientów REST API nasłuchujących aktualizacji. |
apiName | string | Nazwa zagregowanego 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 (/). |
swaggerDefinition | string | Poł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. |
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. |
docURL | string | Adres 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. | |
public | boolean | true | Wartość logiczna, która decyduje o tym, czy moduł WWW jest wyświetlany w publicznym interfejsie API. |