O que é o emulador da Apigee

Esta página se aplica à Apigee e à Apigee híbrida.

Confira a documentação da Apigee Edge.

Importante: abra um espaço de trabalho antes de configurar os emuladores. Consulte Gerenciar o espaço de trabalho da Apigee.

O emulador da Apigee permite simular uma instalação da Apigee no seu ambiente de desenvolvimento local para fins de teste. O emulador da Apigee não substitui uma instalação da Apigee para testes e não tem funcionalidade idêntica, mas simplifica os testes no ambiente de desenvolvimento local.

O emulador da Apigee está disponível como uma imagem do Docker personalizada fornecida publicamente aos desenvolvedores para implantar e testar proxies de API em um ambiente de desenvolvimento local. As imagens do Docker são publicadas regularmente no gcr.

Quando estiver tudo pronto para implantar e testar seu primeiro proxy de API, você vai precisar usar a seção de emuladores para visualizar e gerenciar as versões do emulador e o ciclo de vida dos emuladores configurados.

Observação: as imagens e os exemplos neste guia são para fins de referência e talvez não mostrem a versão mais recente do emulador da Apigee. Sempre use a versão estável mais recente do emulador da Apigee que atenda às suas necessidades. Para saber mais, consulte Como escolher a versão do emulador.

Nessa seção, você pode:

• Conferir as diferentes versões dos emuladores instalados e os contêineres criados para cada versão do emulador, incluindo informações do Docker e do ambiente de execução e portas de controle e tráfego

• Adicionar, excluir, iniciar, interromper, redefinir, e atualizar a visualização dos contêineres do emulador da Apigee, conforme descrito em Como gerenciar o emulador da Apigee.

• Confira os aplicativos implantados (consulte Como implantar ambientes).

• Veja os recursos de teste ativos (consulte Como exportar recursos de teste para o emulador da Apigee).

Como gerenciar o Apigee Emulator

Gerencie o Apigee Emulator conforme descrito nas seções a seguir.

Observação: é necessário que o Docker esteja instalado e em execução no seu sistema para que o emulador da Apigee seja instalado e executado.

Escolher a versão do emulador

Por padrão, a pasta emulador mostra uma versão estável. No entanto, é possível escolher uma versão diferente com base nos seus requisitos.

1. Confira uma lista de versões do emulador da Apigee no Google Artifact Registry e anote o valor de Tag. Para mais informações, consulte a documentação do Artifact Registry.

   

2. Para adicionar uma versão do emulador da Apigee à extensão do Cloud Code, clique em Gerenciar > Configurações e pesquise apigee emulators.

3. Clique em Adicionar item.

4. Insira o valor da Tag gerado na etapa 1. Por exemplo, 1.10.0 ougcr.io/apigee-release/hybrid/apigee-emulator:1.10.0.

5. Clique em OK.

6. O emulador recém-adicionado aparece na pasta emuador.

Como instalar o emulador da Apigee

Para instalar o emulador da Apigee:

1. Abra a pasta emuladores no seu espaço de trabalho.

2. Posicione o cursor sobre a versão do Emulador da Apigee a ser instalada.

3. Clique em .

   

4. Adicione um contêiner seguindo as instruções em Como adicionar um contêiner para o Apigee.

   Emulador

A imagem mais recente da versão selecionada do emulador da Apigee está instalada. Após a conclusão da instalação, a mensagem Emulator installed successfully será exibida, e o status do contêiner do emulador da Apigee mudará para Pronto.

Como adicionar um contêiner ao emulador da Apigee

Para adicionar um contêiner para o Apigee Emulator usando a IU:

1. Expanda a pasta emuladores.

   

2. Posicione o cursor sobre o emulador da Apigee em que você quer adicionar um contêiner.

3. Clique em +.

4. Digite um nome exclusivo para o contêiner do Emulador da Apigee e pressione Enter. Insira caracteres alfanuméricos, traços (-) ou sublinhados (_).

5. Digite o valor numérico a ser usado como porta de controle do contêiner do emulador da Apigee e pressione Enter. A porta de controle precisa ser exclusiva entre os contêineres. O padrão é 8080.

   Importante! A porta de controle precisa ser exclusiva e não pode ser usada por outro componente.

6. Digite o valor numérico a ser usado como a porta de tráfego do contêiner do emulador da Apigee e pressione Enter. A porta de tráfego precisa ser exclusiva entre contêineres. O padrão é 8998.

   Importante! A porta de tráfego precisa ser exclusiva e não pode ser usada por outro componente.

O contêiner é adicionado.

Como visualizar as informações de status para o Apigee Emulator

Veja as informações de status do emulador da Apigee, conforme descrito nas seções a seguir.

Como usar a IU

Para ver as informações de status do Emulador da Apigee, incluindo as informações do Docker e do ambiente de execução, expanda o contêiner na seção Emuladores. As informações que você vê correspondem à versão do emulador da Apigee em uso.

Como usar a CLI do Docker

Para visualizar as informações de status do contêiner para o emulador da Apigee e suas portas configuradas, execute docker ps na guia Terminal. Veja a seguir um exemplo de resposta. A resposta real que você vê depende da versão do emulador da Apigee em uso:

CONTAINER ID   IMAGE                                COMMAND       CREATED        STATUS        PORTS                                      NAMES
33756b8c5c5b   ...apigee-emulator:1.11.0   "/usr/bin…"   10 hours ago   Up 10 hours   7000-7001/tcp, 0.0.0.0:8080->8080/tcp...   apigee-emulator

Consulte também Como personalizar o contêiner do Docker do ambiente de execução da Apigee.

Como iniciar o Apigee Emulator

Inicie o Apigee Emulator conforme descrito nas seções a seguir.

Como usar a IU

Para iniciar o Emulador da Apigee, posicione o cursor sobre o contêiner que você quer iniciar e clique em .

Como usar a CLI do Docker

Para iniciar o Emulador da Apigee, execute docker start CONTAINER_NAME

na guia Terminal.

O status será definido como Ready:

Consulte também Como personalizar o contêiner do Docker do ambiente de execução da Apigee.

Como redefinir o Apigee Emulator

Redefina o Emulador da Apigee para remover todas as implantações e recursos de teste exportados conforme descrito nas seções a seguir.

Como usar a IU

Para redefinir o Emulador da Apigee, posicione o cursor sobre o contêiner do Emulador da Apigee na seção Emuladores e clique em .

O emulador da Apigee é redefinido e o status é definido como Ready:

As seguintes informações são exibidas na guia Saída:

Resetting the Apigee Emulator
Reset completed

Consulte também Como personalizar o contêiner do Docker do ambiente de execução da Apigee.

Como reiniciar o Apigee Emulator

Para reiniciar o emulador da Apigee, execute docker restart CONTAINER_NAME na guia Terminal. Por exemplo: docker restart MyContainer

Como atualizar o emulador da Apigee

Se o Emulador da Apigee não estiver sincronizado com a versão mais recente, será possível atualizar a versão instalada usando a interface ou a CLI do Docker, conforme descrito nas seções a seguir.

Como usar a IU

Para atualizar o Emulador da Apigee, posicione o cursor sobre o Emulador da Apigee na seção Emuladores e clique em .

Como usar a CLI do Docker

Para atualizar o emulador da Apigee, execute os seguintes comandos do Docker na guia Terminal, usando a versão apropriada mais recente:

• Execute docker ps para conseguir o nome da imagem. Exemplo: gcr.io/apigee-release/hybrid/apigee-emulator:EMULATOR_VERSION

• Execute docker pull IMAGE_NAME para atualizar a imagem de instalação do emulador da Apigee. Exemplo: docker pull gcr.io/apigee-release/hybrid/apigee-emulator:EMULATOR_VERSION

O emulador da Apigee é atualizado e a seguinte mensagem é exibida: Emulator version is up to date

Consulte também Como personalizar o contêiner do Docker do ambiente de execução da Apigee.

Como interromper o Apigee Emulator

Interrompa o Emulador da Apigee usando a interface ou a CLI do Docker, conforme descrito nas seções a seguir.

Como usar a IU

Para interromper o Emulador da Apigee, posicione o cursor sobre o contêiner do Emulador da Apigee na seção emuladores e clique em .

Como usar a CLI do Docker

Para interromper o Emulador da Apigee, execute docker stop CONTAINER_NAME na guia Terminal.

O Emulador da Apigee será interrompido e o status será alterado para Not running:

Consulte também Como personalizar o contêiner do Docker do ambiente de execução da Apigee.

Como excluir um contêiner para o emulador da Apigee

Exclua um contêiner do Emulador da Apigee usando a IU ou o CL do Docker, conforme descrito nas seções a seguir.

Como usar a IU

Para excluir o Emulador da Apigee, posicione o cursor sobre o contêiner do Emulador da Apigee na seção emuladores e clique em .

Como usar a CLI do Docker

Para excluir um contêiner do emulador da Apigee, execute os seguintes comandos do Docker na guia Terminal:

• Execute docker stop CONTAINER_NAME para interromper a imagem de instalação do emulador da Apigee, se ela ainda não tiver sido interrompida. Por exemplo: docker stop MyContainer

• Execute docker rm CONTAINER_NAME para interromper a imagem de instalação do emulador da Apigee. Por exemplo: docker rm MyContainer

O contêiner é excluído.

Consulte também Como personalizar o contêiner do Docker do ambiente de execução da Apigee.

Como personalizar o contêiner do Docker do ambiente de execução da Apigee

É possível personalizar a linha de comando do Docker usada para controlar as instâncias do emulador da Apigee usando as opções a seguir.

Observação: não é necessário personalizar o contêiner do Docker do ambiente de execução da Apigee. Se não for especificado, os valores padrão das opções vão ser usados. As alterações nas opções são aplicáveis somente aos contêineres criados depois que as opções são modificadas. Se quiser que as opções sejam aplicadas a contêineres atuais, é necessário recriá-las.

Opção	Descrição
additionalArguments	Adicione um ou mais argumentos. Os argumentos são adicionados ao comando docker run exatamente como fornecido. O padrão é "" (nenhum).
detached	Controla se a opção --detached é usada durante a execução do contêiner. O padrão é true.
dns	Controla a sinalização -dns do serviço DNS, conforme descrito em Serviços DNS. O padrão é 8.8.8.8.
environmentVariables	Adicione variáveis de ambiente ao comando docker run, conforme descrito em Opções. Os valores, se fornecidos, são adicionados ao comando docker run usando -e name=value. A lista padrão inclui "XTERM": "xterm-256color".
labels	Adicione um ou mais rótulos a serem anexados ao contêiner. Os rótulos são adicionados ao comando docker run usando -l label:value. O padrão é none.
privileged	Controla se a opção --privileged é usada durante a execução do contêiner. O padrão é true.
volumes	Adicione um ou mais volumes para serem montados no contêiner. Os volumes são adicionados ao comando docker run usando -v label:value. O padrão é none.

Para personalizar o contêiner do Docker do ambiente de execução da Apigee, siga estas etapas:

1. Esse recurso está disponível como parte do build Insiders (v1.21.0 e mais recentes). Instale o build Insiders, conforme descrito em Como instalar builds Insiders.

2. Clique em Gerenciar > Configurações e procure apigee docker.

3. Em Cloudcode > Apigee: opções do Docker, clique em Editar em settings.json. As opções personalizáveis aparecerão no arquivo settings.json da seguinte maneira:

   "cloudcode.apigee.dockerOptions": {
     "environmentVariables": {
         "XTERM": "xterm-256-color"
     },
     "dns": "8.8.8.8",
     "detached": true
     "privileged": true,
     "labels": {},
     "volumes": {},
     "additionalArguments":""
   }

4. Edite as opções e salve o arquivo.

Como personalizar o emulador da Apigee para oferecer suporte à autenticação baseada em conta de serviço

Ao testar os proxies que dependem da autenticação baseada em conta de serviço Google Cloud , o emulador da Apigee precisa acessar a chave da conta de serviço do Google. Siga as etapas para configurar seu emulador da Apigee para aceitar a autenticação baseada em conta de serviço.

Como criar e fazer o download da chave da conta de serviço

Crie uma Google Cloud conta de serviço com o papel Criador de token da conta de serviço, que é um requisito para que o emulador da Apigee seja compatível com contas de serviço. Crie uma chave para a conta de serviço, conforme descrito em Criar uma chave da conta de serviço.

Faça o download da chave no sistema de arquivos local para que ela possa ser fornecida ao emulador da Apigee.

Observação: as chaves de conta de serviço poderão causar problemas de segurança se não forem gerenciadas corretamente. Você é responsável pela segurança da chave privada e por outras operações descritas em Práticas recomendadas para gerenciar chaves de contas de serviço. Se não for possível criar uma chave de conta de serviço, a criação pode ser desativada para sua organização. Para mais informações, consulte Gerenciar recursos da organização com segurança por padrão.

Se você adquiriu a chave de conta de serviço com uma fonte externa, valide-a antes do uso. Para mais informações, consulte Requisitos de segurança para credenciais de fontes externas".

Como configurar o emulador da Apigee

As configurações definidas nesta seção se aplicam somente às instâncias de contêiner do Docker criadas depois que as configurações são salvas.

Para definir as configurações do emulador da Apigee:

1. Abra as opções do Docker, conforme descrito em Como personalizar o contêiner do Docker do ambiente de execução

   da Apigee.

2. Na seção volumes das opções do Docker, adicione um novo volume para que o caminho da chave da conta de serviço salvo fique disponível no contêiner. Supondo que o download da chave tenha sido feito no caminho /opt/apigee/keys/apigee-sa-key.json, a seguinte configuração ativa o conteúdo de /opt/apigee/keys no caminho /emulator/keys dentro do contêiner:

   "volumes": {
     "/opt/apigee/keys":"/emulator/keys"
   }

3. Na seção environmentVariables das opções do Docker, adicione a variável GOOGLE_APPLICATION_CREDENTIALS que aponta para o arquivo no caminho ativado:

   "environmentVariables": {
     "GOOGLE_APPLICATION_CREDENTIALS":"/emulator/keys/apigee-sa-key.json"
   }

4. Salve as configurações e crie uma nova instância de contêiner que possa ser usada para testes.

O exemplo a seguir mostra como associar uma chave de conta de serviço do Google ao emulador da Apigee.

"cloudcode.apigee.dockerOptions": {
      "environmentVariables": {
          "XTERM": "xterm-256-color",
          "GOOGLE_APPLICATION_CREDENTIALS":"/emulator/keys/apigee-sa-key.json"
      },
      "dns": "8.8.8.8",
      "detached": true
      "privileged": true,
      "labels": {},
      "volumes": {
         "/opt/apigee/keys":"/emulator/keys"
      },
      "additionalArguments":""
    }

Como configurar o emulador da Apigee para oferecer suporte ao proxy de encaminhamento HTTP

As configurações definidas nesta seção se aplicam apenas às versões 1.11.0 e mais recentes do emulador.

Muitas vezes, os destinos de back-end associados a um proxy só podem ser alcançados usando um proxy de encaminhamento HTTP. O emulador da Apigee pode ser configurado para usar o proxy de encaminhamento ao se conectar aos destinos usando uma variável de ambiente chamada FORWARD_PROXY.

As configurações definidas nesta seção se aplicam somente às instâncias de contêiner do Docker criadas depois que as configurações são salvas.

Para definir as configurações do emulador da Apigee:

1. Abra as opções do Docker, conforme descrito em Como personalizar o contêiner do Docker do ambiente de execução da Apigee acima.

2. Na seção environmentVariables das opções do Docker, adicione a variável FORWARD_PROXY que aponta para o endereço do proxy de encaminhamento como um URL HTTP.

   "environmentVariables": {
     "FORWARD_PROXY":"http://proxy_host:proxy_port"
   }

3. Salve as configurações e crie uma nova instância de contêiner para teste.