Como usar os proxies de API de exemplo

Você está lendo a documentação do Apigee Edge.
Acesse a documentação da Apigee X. info

Pré-requisitos

Você precisa de uma conta em http://enterprise.apigee.com. É possível se inscrever para uma conta de teste em http://accounts.apigee.com/accounts/sign_up.

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

Ferramenta Descrição
Git As amostras estão localizadas no GitHub. Se você não tiver o Git instalado, consulte as instruções de configuração do Git do GitHub. Se não quiser instalar o Git, você pode navegar pelos arquivos e baixar 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 um computador Windows com o Cygwin instalado e em muitos outros lugares.

Para receber o 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 verificar se ele está disponível no seu sistema.
dos2unix Se você estiver executando o Cygwin no Windows, também poderá precisar do dos2unix utilitário. O instalador do Cygwin permite instalar o utilitário.

Baixar as amostras

Para receber os arquivos de amostra, use git clone, conforme mostrado no exemplo a seguir:

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

Importar e implantar os proxies de API de amostra

Importe e implante as amostras na linha de comando:

  1. Depois de baixar as amostras, acesse o diretório /setup, conforme mostrado no exemplo a seguir: 
    cd setup
  2. No diretório /setup, localize o arquivo setenv.sh.
  3. Edite esse arquivo para definir sua 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 3 a 4 minutos. Siga as instruções para implantar produtos de API, desenvolvedores e apps (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 mudanças nas amostras, implantar e invocar a amostra para ver o efeito da mudança:
    • invoke.sh: execute esse script para invocar a versão implantada do proxy de API.
    • deploy.sh: execute esse script para implantar o proxy de API depois de fazer mudanças.

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 depois da implantação.

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

sh invoke.sh

Isso invoca o proxy que está em execução no ambiente de teste da sua organização.

Solução de problemas

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

Modificar e reutilizar os proxies de API de amostra

O uso típico dos proxies de amostra é modificar, implantar e invocar. Isso permite fazer pequenas modificações e verificar o efeito delas na mensagem de resposta.

Para modificar um proxy de API de amostra 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 a amostra 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/, então você modifica 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 mudanças, implante o proxy de API, conforme mostrado no exemplo a seguir:

sh deploy.sh

Os outros proxies de API podem ser modificados da mesma forma para usar a funcionalidade de proxy de API nos serviços de destino atuais. 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 mudanças de configuração.