openapi - OpenAPI (openapi)

Konfigurace pro funkci OpenAPI.

NameTypeDefaultDescription
customizationstringUrčuje umístění úseku kódu OpenAPI pro přizpůsobení.
enablePrivateURLbooleanfalseLogická hodnota, která řídí, zda jsou povoleny koncové body dokumentace k soukromému rozhraní API.
publicURLstring/apiUrčuje kontextový kořenový adresář pro koncové body dokumentace k veřejným rozhraním API. Adresa URL nevyžaduje dopředné lomítko (/).
validationbooleanfalseHodnota boolean, která určuje, zda jsou dokumenty OpenAPI ověřovány.
disableFileMonitorbooleanfalseHodnota boolean, která řídí, zda jsou soubory přizpůsobení monitorovány.

webModuleDoc

Konfigurace jednotlivých webových modulů poskytujících dokumentaci rozhraní API, která se má vystavit.

NameTypeDefaultDescription
idřetězecJedinečné ID konfigurace.
contextRootstringKontextový kořenový adresář webového modulu, pro který poskytujete dokumentaci.
enabledbooleantrueLogická hodnota, která řídí zpracování dokumentace tohoto webového modulu.
publicbooleantrueLogická hodnota, která řídí, zda se bude webový modul zobrazovat ve veřejném rozhraní API.