openapi - OpenAPI (openapi)

Configuração para o recurso OpenAPI.

NameTypeDefaultDescription
customizationstringEspecifica o local de um snippet OpenAPI para customização.
enablePrivateURLbooleanofalseUm booleano que controla se os terminais de documentação da API privada são ativados.
publicURLstring/apiEspecifica a raiz de contexto para os terminais de documentação da API pública. A URL não requer uma barra (/).
validationbooleanofalseUm booleano que controla se os documentos OpenAPI são validados.
disableFileMonitorbooleanofalseUm booleano que controla se os arquivos de customização são monitorados.

webModuleDoc

A configuração para cada módulo da web fornece a documentação API a ser exposta.

NameTypeDefaultDescription
idsequênciaUm ID de configuração exclusivo.
contextRootstringA raiz de contexto do módulo da web para o qual a documentação está sendo fornecida.
enabledbooleanotrueUm booleano que controla o processamento da documentação para esse módulo da web.
publicbooleanotrueUm booleano que controla se o módulo da web é exibido na API pública.