Como usar os proxies de API de exemplo

Você está vendo a documentação do Apigee Edge.
Acesse a documentação da Apigee X. informações

Pré-requisitos

Você precisará de uma conta em http://enterprise.apigee.com e se inscreva para uma conta de teste em http://accounts.apigee.com/accounts/sign_up.

Para usar amostras, você também precisa ter o seguinte:

Ferramenta	Descrição
Git	Os exemplos estão disponíveis no GitHub. Se você não tiver o Git instalado, consulte as instruções de configuração do git no GitHub (em inglês). Se não quiser instalar o Git, procure os arquivos e faça o download de um ZIP em https://github.com/apigee/api-platform-samples.
Python	O Python é necessário para executar a ferramenta de implantação da Apigee. O Python está presente na maioria dos ambientes Linux, em um Mac com o XCode instalado, em uma máquina Windows com Cygwin instalado e em muitos outros lugares. Para fazer o download do Python, consulte a página de download do Python.
curl	Os scripts de configuração de amostra também usam curl. Verifique se curl está instalado e disponível no seu caminho. Execute o comando which curl para ver se ele está disponível no sistema.
dos2unix	Se você estiver executando o Cygwin no Windows, talvez também seja necessário usar o utilitário dos2unix. O instalador do Cygwin permite que você instale o utilitário.

Fazer o download das amostras

Para acessar os arquivos de amostra, use git clone, como no exemplo a seguir:

git clone https://github.com/apigee/api-platform-samples.git

Importe e implante os proxies de API de exemplo

Importe e implante as amostras pela linha de comando:

1. Depois de fazer o download das amostras, acesse o diretório /setup, como mostra o exemplo a seguir:

   cd setup

2. No diretório /setup, localize o arquivo setenv.sh.
3. Edite esse arquivo para configurar a organização, o endereço de e-mail associado ao seu nome de usuário e o ambiente (produção ou teste) em que você quer implantar os proxies de API.
4. Depois de editar setenv.sh, execute o seguinte:

   sh deploy_all.sh

   Esse script implanta todas as amostras de proxy de API na sua organização. O processo leva de três a quatro minutos. Siga as instruções para implantar produtos, desenvolvedores e apps de API (que são usados para OAuth).

5. Depois que o script de implantação for concluído, navegue até o diretório sample-proxies. No diretório sample-proxies, você encontrará um diretório por proxy de amostra. Em cada diretório, há um arquivo README.md com informações sobre como executar a amostra e dois scripts que ajudam você a fazer pequenas alterações nas amostras, implantar e invocar a amostra para conferir o efeito da mudança:
   • invoke.sh: execute este script para invocar a versão implantada do proxy de API.
   • deploy.sh: execute este script para implantar o proxy de API depois de fazer qualquer alteração.

Invocar os proxies de API de amostra

Cada proxy de amostra tem um script de shell associado que pode ser usado para invocar o proxy de API após a implantação.

No diretório /sample-proxies/proxy_name, execute o seguinte:

sh invoke.sh

Isso invoca o proxy em execução no ambiente de teste da organização.

Solução de problemas

Para informações sobre solução de problemas, consulte:

• Introdução à solução de problemas
• Solução de problemas do Windows/Cygwin

Modificar e reutilizar os proxies de API de exemplo

O uso típico dos proxies de amostra é modificar, implantar e invocar. Isso permite que você faça pequenas modificações e depois analise o efeito que elas têm na mensagem de resposta.

Para modificar um proxy de API de exemplo para apontar para um serviço de back-end diferente, modifique o arquivo de configuração XML no seguinte local:

/apiproxy/targets/target_name.xml

Por exemplo, para apontar o exemplo de chave de API para seu próprio serviço de back-end, localize este arquivo:

/apikey/apiproxy/targets/default.xml

Se a configuração padrão apontar para http://mocktarget.apigee.net, como:

<TargetEndpoint name="default">
  <HTTPTargetConnection>
    <!-- This is where we define the target. For this sample we just use a simple URL. -->
    <URL>http://mocktarget.apigee.net</URL>
  </HTTPTargetConnection>
</TargetEndpoint>

e seu serviço de back-end estiver disponível em http://api.myproject.com/, modifique a configuração para que ela fique assim:

<TargetEndpoint name="default">
  <HTTPTargetConnection>
    <!-- This is where we define the target. For this sample we just use a simple URL. -->
    <URL>http://api.myproject.com/</URL>
  </HTTPTargetConnection>
</TargetEndpoint>

Depois de salvar as alterações, implante o proxy de API, como mostra o exemplo a seguir:

sh deploy.sh

Os outros proxies de API podem ser modificados da mesma maneira para usar a funcionalidade de proxy de API nos serviços de destino existentes. No entanto, em alguns casos, o comportamento do proxy de API depende de formatos de mensagem específicos. Portanto, os proxies podem precisar de outras alterações de configuração.