Configuração para o recurso OpenAPI.
Name | Type | Default | Description |
---|---|---|---|
customization | string | Especifica o local de um snippet OpenAPI para customização. | |
enablePrivateURL | booleano | false | Um booleano que controla se os terminais de documentação da API privada são ativados. |
publicURL | string | /api | Especifica a raiz de contexto para os terminais de documentação da API pública. A URL não requer uma barra (/). |
validation | booleano | false | Um booleano que controla se os documentos OpenAPI são validados. |
disableFileMonitor | booleano | false | Um booleano que controla se os arquivos de customização são monitorados. |
A configuração para cada módulo da web fornece a documentação API a ser exposta.
Name | Type | Default | Description |
---|---|---|---|
id | sequência | Um ID de configuração exclusivo. | |
contextRoot | string | A raiz de contexto do módulo da web para o qual a documentação está sendo fornecida. | |
enabled | booleano | true | Um booleano que controla o processamento da documentação para esse módulo da web. |
public | booleano | true | Um booleano que controla se o módulo da web é exibido na API pública. |