Konfigurace pro funkci OpenAPI.
Name | Type | Default | Description |
---|---|---|---|
customization | string | Určuje umístění úseku kódu OpenAPI pro přizpůsobení. | |
enablePrivateURL | boolean | false | Logická hodnota, která řídí, zda jsou povoleny koncové body dokumentace k soukromému rozhraní API. |
publicURL | string | /api | Určuje kontextový kořenový adresář pro koncové body dokumentace k veřejným rozhraním API. Adresa URL nevyžaduje dopředné lomítko (/). |
validation | boolean | false | Hodnota boolean, která určuje, zda jsou dokumenty OpenAPI ověřovány. |
disableFileMonitor | boolean | false | Hodnota boolean, která řídí, zda jsou soubory přizpůsobení monitorovány. |
Konfigurace jednotlivých webových modulů poskytujících dokumentaci rozhraní API, která se má vystavit.
Name | Type | Default | Description |
---|---|---|---|
id | řetězec | Jedinečné ID konfigurace. | |
contextRoot | string | Kontextový kořenový adresář webového modulu, pro který poskytujete dokumentaci. | |
enabled | boolean | true | Logická hodnota, která řídí zpracování dokumentace tohoto webového modulu. |
public | boolean | true | Logická hodnota, která řídí, zda se bude webový modul zobrazovat ve veřejném rozhraní API. |