O SmartDocs é instalado automaticamente quando você instala e executa os scripts de teste de instalação
descritos em Testar a instalação. Como parte da execução dos scripts de teste, execute os seguintes comandos:
Esse comando vai retornar o seguinte se o SmartDocs estiver instalado:
[ "smartdocs", "passthrough" ]
Na interface do Edge, crie e atualize um KVM chamado "smartdocs_whitelist", conforme mostrado na figura abaixo.
A KVM deve ser criada na organização e no ambiente em que o proxy SmartDocs está
implantados atualmente.
Observação: verifique se a caixa encrypted NÃO está marcada.
Adicione uma chave chamada “is_permissions_configured”, em que o valor seja “YES”.
Adicione uma segunda chave chamada "allowed_hosts", em que os valores são nomes de host ou endereços IP separados por espaços, chamados do SmartDocs. O valor de "allowed_hosts" precisa incluir todos os hosts incluídos nas especificações da OpenAPI
adicionadas ao SmartDocs. Por exemplo, se você tiver uma especificação OpenAPI que chama mocktarget.apigee.net,
será necessário adicionar mocktarget.apigee.net ao valor "allowed_hosts". Se um host não for
incluído na KVM, a resposta do SmartDocs será 400 Bad Request com um conteúdo
payload de Bad Request-Hostname not permitted.
Observação: se você não adicionar e configurar esse KVM, o proxy não vai aplicar a inclusão na lista de permissões. Isso
pode resultar em acesso não autorizado aos seus hosts e endereços IP. Somente nomes de host e endereços IP de
Os endpoints de API documentados com o SmartDocs precisam ser incluídos em "allowed_hosts" e a distribuição dos valores dos dados.