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 do teste,
scripts, execute os seguintes comandos:
Se o SmartDocs estiver instalado, o comando retornará o seguinte:
[ "smartdocs", "passthrough" ]
Na interface do Edge, crie e atualize uma KVM chamada “smartdocs_permissions”, como 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ço
chamados no SmartDocs. O valor de "allowed_hosts" deve incluir todos os hosts incluídos nas especificações da OpenAPI
aos SmartDocs. Por exemplo, se você tem uma especificação OpenAPI que chama mocktarget.apigee.net,
adicione mocktarget.apigee.net a "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 essa KVM, o proxy não aplicará a 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.