Instalar o SmartDocs

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, você executa os seguintes comandos:

/opt/apigee/apigee-service/bin/apigee-service apigee-validate install
/opt/apigee/apigee-service/bin/apigee-service apigee-validate setup -f configFile

Em que configFile é o mesmo arquivo de configuração usado para instalar o Edge. Consulte Instalar componentes do Edge em um nó para saber mais.

Esse comando instala o SmartDocs como parte da execução dos testes.

Para concluir a instalação:

  1. Confirme se o SmartDocs está instalado, confirmando se o arquivo smartdocs.zip está 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

    Se o SmartDocs estiver instalado, esse comando retornará o seguinte:

    [ "smartdocs", "passthrough" ]
  2. Na IU do Edge, crie e atualize uma KVM chamada "smartdocs_whitelist", conforme mostrado na figura abaixo. A KVM precisa ser criada na organização e no ambiente em que o proxy SmartDocs está implantado atualmente.

    Observação: confirme se a caixa encrypted 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 separados por espaço ou endereços IP chamados do SmartDocs. O valor de "allowed_hosts" precisa incluir os hosts adicionados às especificações da OpenAPI adicionadas ao SmartDocs. Por exemplo, se você tiver uma especificação OpenAPI que chame mocktarget.apigee.net, será necessário adicionar mocktarget.apigee.net ao valor "allowed_hosts". Se um host não estiver incluído na KVM, a resposta do SmartDocs será 400 Bad Request com um payload de conteúdo de Bad Request-Hostname not permitted.
    Interface de criação de KVM 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 endpoints da API documentados com SmartDocs devem ser incluídos nos valores "allowed_hosts".