Esta é a documentação do Apigee Edge.
Acesse
Documentação da Apigee X. informações
Pré-requisitos
Você precisará de uma conta em http://enterprise.apigee.com. Você pode se inscrever para uma conta de teste em http://accounts.apigee.com/accounts/sign_up.
Para usar amostras, você também precisa ter:
Ferramenta | Descrição |
---|---|
Git | Os exemplos estão no GitHub. Se você não tiver o Git instalado, consulte Instruções de configuração do Git do GitHub (link em inglês). Se você 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 (link em inglês). |
Python |
O Python é necessário para executar a ferramenta de implantação da Apigee. O Python está presente na maioria dos Linux ambientes, em um Mac com XCode instalado, em uma máquina Windows com Cygwin instalado e em muitos outros lugares. Para obter o Python, consulte a Página de download do Python. |
curl |
Os exemplos de scripts de configuração também usam curl . Verifique se o curl está instalado e
disponível no seu caminho (execute o comando which curl para ver se está disponível na
seu sistema). |
dos2unix |
Se você estiver executando o Cygwin no Windows, talvez seja necessário usar o dos2unix
utilitário. O instalador 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
Importar e implantar a API de amostra proxies
Importe e implante as amostras na linha de comando:
- Depois de fazer o download dos exemplos, acesse o diretório
/setup
, como mostra o exemplo a seguir:cd setup
- No diretório
/setup
, localize o arquivosetenv.sh
. - Edite este 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 da API.
- 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 minutes.) Siga as instruções para implantar produtos, desenvolvedores e apps de API (que são usados para OAuth).
- Após a conclusão do script de implantação, acesse o diretório sample-proxies. Na
sample-proxies
, você encontrará um diretório por proxy de amostra. Em cada diretório é um arquivo README.md com informações sobre como executar a amostra e dois scripts que fazer pequenas alterações nos exemplos, implantar e invocar o exemplo para conferir qual efeito a mudança teve:invoke.sh
: executa este script para invocar a versão implantada da API proxy.deploy.sh
: execute este 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 de implantá-lo.
No diretório /sample-proxies/proxy_name
, execute o
seguintes:
sh invoke.sh
Isso invoca o proxy que está sendo executado no ambiente de teste na organização.
Solução de problemas
Para informações sobre solução de problemas, consulte:
Modificar e reutilizar os proxies da API de amostra
O uso típico dos proxies de amostra é modificar, implantar e invocar. Isso permite que você faça fazer pequenas modificações e, em seguida, verificar o efeito que elas têm na mensagem de resposta.
Para modificar um proxy de API de amostra para apontar para um serviço de back-end diferente, modifique o XML de configuração no seguinte local:
/apiproxy/targets/target_name.xml
Por exemplo, para apontar a amostra da chave de API no 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/
, você
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 em relação aos serviços de destino existentes. Em alguns casos, porém, o comportamento do proxy de API depende da formatos de mensagem específicos, portanto, talvez os proxies precisem de alterações de configuração adicionais.