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:
/opt/apigee/apigee-service/bin/apigee-service apigee-validate install
/opt/apigee/apigee-service/bin/apigee-service apigee-validate setup -f configFileEm que configFile é o mesmo arquivo de configuração usado para instalar o Edge. Consulte Instalar componentes do Edge em um nó para mais informações.
Esse comando instala o SmartDocs como parte da execução dos testes.
Para concluir a instalação:
Para testar se o SmartDocs está instalado, confirme se o arquivo
smartdocs.zipestá localizado no seguinte diretório:/opt/apigee/apigee-validate/bundles/
Ou execute a seguinte chamada de API no nó do servidor de gerenciamento:
curl -v -u adminEmail:adminPword 0:8080/v1/o/validate/apis
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", como mostrado na figura abaixo.
O KVM precisa ser criado na organização e no ambiente em que o proxy do SmartDocs está
implantado.
Observação: verifique se a caixa criptografado NÃO está marcada.
- Adicione uma chave chamada "is_whitelist_configured", em que o valor é "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 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 adicionarmocktarget.apigee.netao valor "allowed_hosts". Se um host não estiver incluído no KVM, a resposta do SmartDocs será400 Bad Requestcom um payload de conteúdo deBad Request-Hostname not permitted.
Observação: se você não adicionar e configurar esse KVM, o proxy não vai 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
endpoints de API documentados com o SmartDocs devem ser incluídos nos valores "allowed_hosts".